/**
* Describe the AboveAverage conditional formatting rule.
* This conditional formatting rule highlights cells that
* are above or below the average for all values in the range.
*/
class AboveAverage {
/**
*/
constructor() {
}
/**
* Get or set the flag indicating whether the rule is an "above average" rule.
* 'true' indicates 'above average'.
* Default value is true.
*/
isAboveAverage() {
}
/**
* Get or set the flag indicating whether the rule is an "above average" rule.
* 'true' indicates 'above average'.
* Default value is true.
*/
setAboveAverage(value) {
}
/**
* Get or set the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria
* is inclusive of the average itself, or exclusive of that value.
* 'true' indicates to include the average value in the criteria.
* Default value is false.
*/
isEqualAverage() {
}
/**
* Get or set the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria
* is inclusive of the average itself, or exclusive of that value.
* 'true' indicates to include the average value in the criteria.
* Default value is false.
*/
setEqualAverage(value) {
}
/**
* Get or set the number of standard deviations to include above or below the average in the
* conditional formatting rule.
* The input value must between 0 and 3 (include 0 and 3).
* Setting this value to 0 means stdDev is not set.
* The default value is 0.
*/
getStdDev() {
}
/**
* Get or set the number of standard deviations to include above or below the average in the
* conditional formatting rule.
* The input value must between 0 and 3 (include 0 and 3).
* Setting this value to 0 means stdDev is not set.
* The default value is 0.
*/
setStdDev(value) {
}
}
/**
* Monitor for user to track the progress of formula calculation.
* @hideconstructor
*/
class AbstractCalculationMonitor {
/**
* Gets the old value of the calculated cell.
* Should be used only in beforeCalculate(int, int, int) and afterCalculate(int, int, int).
*/
getOriginalValue() {
}
/**
* Whether the cell's value has been changed after the calculation.
* Should be used only in afterCalculate(int, int, int).
*/
getValueChanged() {
}
/**
* Gets the newly calculated value of the cell.
* Should be used only in afterCalculate(int, int, int).
*/
getCalculatedValue() {
}
/**
* Implement this method to do business before calculating one cell.
* @param {Number} sheetIndex - Index of the sheet that the cell belongs to.
* @param {Number} rowIndex - Row index of the cell
* @param {Number} colIndex - Column index of the cell
*/
beforeCalculate(sheetIndex, rowIndex, colIndex) {
}
/**
* Implement this method to do business after one cell has been calculated.
* @param {Number} sheetIndex - Index of the sheet that the cell belongs to.
* @param {Number} rowIndex - Row index of the cell
* @param {Number} colIndex - Column index of the cell
*/
afterCalculate(sheetIndex, rowIndex, colIndex) {
}
/**
* Implement this method to do business when calculating formulas with circular references.
* In the implementation user may also set the expected value as calculated result
* for part/all of those cells so the formula engine will not calculate them recursively.
* @param {Iterator} circularCellsData - IEnumerator with
* @return {boolean} Whether the formula engine needs to calculate those cells in circular after this call.
* True to let the formula engine continue to do calculation for them.
* False to let the formula engine just mark those cells as Calculated.
*/
onCircular(circularCellsData) {
}
}
/**
* Represents the globalization settings.
* @hideconstructor
*/
class AbstractGlobalizationSettings {
/**
* Compares two string values according to certain collation rules.
* @param {String} v1 - the first string
* @param {String} v2 - the second string
* @param {boolean} ignoreCase - whether ignore case when comparing values
* @return {Number} Integer that indicates the lexical relationship between the two comparands
*/
compare(v1, v2, ignoreCase) {
}
/**
* Transforms the string into a comparable object according to certain collation rules.
* @param {String} v - String value needs to be compared with others.
* @param {boolean} ignoreCase - whether ignore case when comparing values
* @return {IComparable} Object can be used to compare or sort string values
*/
getCollationKey(v, ignoreCase) {
}
}
/**
* Monitor for interruption requests in all time-consuming operations.
* @hideconstructor
*/
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.
*/
isInterruptionRequested() {
}
/**
* When procedure is interrupted, whether terminate the procedure quietly or throw an Exception.
* Default is false, that is, when IsInterruptionRequested is true,
* a CellsException with code ExceptionType.INTERRUPTED will be thrown.
*/
getTerminateWithoutException() {
}
}
/**
* Common options for loading text values
* @hideconstructor
*/
class AbstractTextLoadOptions {
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
getEncoding() {
}
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
setEncoding(value) {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
getLoadStyleStrategy() {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
setLoadStyleStrategy(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
getConvertNumericData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
setConvertNumericData(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
getConvertDateTimeData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
setConvertDateTimeData(value) {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
getKeepPrecision() {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
setKeepPrecision(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* This class specifies an accent equation, consisting of a base component and a combining diacritic.
* @hideconstructor
*/
class AccentEquationNode {
/**
* 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.
* 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() {
}
/**
* 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.
* 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) {
}
/**
* Specify combining characters by type value.
* The value of the property is EquationCombiningCharacterType integer constant.
*/
getAccentCharacterType() {
}
/**
* Specify combining characters by type value.
* The value of the property is EquationCombiningCharacterType integer constant.
*/
setAccentCharacterType(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents the ActiveX control.
* @hideconstructor
*/
class ActiveXControl {
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Represents the ActiveX control.
* @hideconstructor
*/
class ActiveXControlBase {
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
}
/**
* Represents the arc shape.
* @example
* //Use Aspose.Cells for Node.js via Java
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* //Instantiate a new Workbook.
* var excelbook = new aspose.cells.Workbook();
* //Add an arc shape.
* var arc1 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.ARC, 2, 0, 2, 0, 130, 130);
* //Set the placement of the arc.
* arc1.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Set the fill format.
* arc1.getFillFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the line style.
* arc1.getLineFormat().setStyle(aspose.cells.MsoLineStyle.SINGLE);
* //Set the line weight.
* arc1.getLineFormat().setWeight(1);
* //Set the color of the arc line.
* arc1.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the arc.
* arc1.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Add another arc shape.
* var arc2 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.ARC, 9, 0, 2, 0, 130, 130);
* //Set the placement of the arc.
* arc2.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Set the line style.
* arc2.getLineFormat().setStyle(aspose.cells.MsoLineStyle.SINGLE);
* //Set the line weight.
* arc2.getLineFormat().setWeight(1);
* //Set the color of the arc line.
* arc2.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the arc.
* arc2.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Save the excel file.
* excelbook.save("Book1.xls");
* @hideconstructor
*/
class ArcShape {
/**
* Gets and sets the begin arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBeginArrowheadStyle() {
}
/**
* Gets and sets the begin arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBeginArrowheadStyle(value) {
}
/**
* Gets and sets the begin arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBeginArrowheadWidth() {
}
/**
* Gets and sets the begin arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBeginArrowheadWidth(value) {
}
/**
* Gets and sets the begin arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBeginArrowheadLength() {
}
/**
* Gets and sets the begin arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBeginArrowheadLength(value) {
}
/**
* Gets and sets the end arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getEndArrowheadStyle() {
}
/**
* Gets and sets the end arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEndArrowheadStyle(value) {
}
/**
* Gets and sets the end arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getEndArrowheadWidth() {
}
/**
* Gets and sets the end arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEndArrowheadWidth(value) {
}
/**
* Gets and sets the end arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getEndArrowheadLength() {
}
/**
* Gets and sets the end arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEndArrowheadLength(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Encapsulates the object that represents an area format.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
* chart.getNSeries().add("A1:B3", true);
* //Setting the foreground color of the plot area
* chart.getPlotArea().getArea().setForegroundColor(aspose.cells.Color.getBlue());
* //Setting the foreground color of the chart area
* chart.getChartArea().getArea().setForegroundColor(aspose.cells.Color.getYellow());
* //Setting the foreground color of the 1st NSeries area
* chart.getNSeries().get(0).getArea().setForegroundColor(aspose.cells.Color.getRed());
* //Setting the foreground color of the area of the 1st NSeries point
* chart.getNSeries().get(0).getPoints().get(0).getArea().setForegroundColor(aspose.cells.Color.getCyan());
* //Saving the Excel file
* workbook.save("C:\\book1.xls");
* @hideconstructor
*/
class Area {
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
getBackgroundColor() {
}
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
setBackgroundColor(value) {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
getForegroundColor() {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
setForegroundColor(value) {
}
/**
* Represents the formatting of the area.
* The value of the property is FormattingType integer constant.
*/
getFormatting() {
}
/**
* Represents the formatting of the area.
* The value of the property is FormattingType integer constant.
*/
setFormatting(value) {
}
/**
* If the property is true and the value of chart point is a negative number,
* the foreground color and background color will be exchanged.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(-100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "A3"
* chart.getNSeries().add("A1:A3", true);
* chart.getNSeries().get(0).getArea().setInvertIfNegative(true);
* //Setting the foreground color of the 1st NSeries area
* chart.getNSeries().get(0).getArea().setForegroundColor(aspose.cells.Color.getRed());
* //Setting the background color of the 1st NSeries area.
* //The displayed area color of second chart point will be the background color.
* chart.getNSeries().get(0).getArea().setBackgroundColor(aspose.cells.Color.getYellow());
* //Saving the Excel file
* workbook.save("C:\\book1.xls");
*/
getInvertIfNegative() {
}
/**
* If the property is true and the value of chart point is a negative number,
* the foreground color and background color will be exchanged.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(-100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "A3"
* chart.getNSeries().add("A1:A3", true);
* chart.getNSeries().get(0).getArea().setInvertIfNegative(true);
* //Setting the foreground color of the 1st NSeries area
* chart.getNSeries().get(0).getArea().setForegroundColor(aspose.cells.Color.getRed());
* //Setting the background color of the 1st NSeries area.
* //The displayed area color of second chart point will be the background color.
* chart.getNSeries().get(0).getArea().setBackgroundColor(aspose.cells.Color.getYellow());
* //Saving the Excel file
* workbook.save("C:\\book1.xls");
*/
setInvertIfNegative(value) {
}
/**
* Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
*/
getFillFormat() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
}
/**
* Represents autofiltering for the specified worksheet.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook("Book1.xls");
* //Accessing the first worksheet in the Excel file
* var worksheet = workbook.getWorksheets().get(0);
* //Creating AutoFilter by giving the cells range of the heading row
* worksheet.getAutoFilter().setRange("A1:B1");
* //Filtering columns with specified values
* worksheet.getAutoFilter().filter(1, "Bananas");
* //Saving the modified Excel file.
* workbook.save("Book2.xls");
* @hideconstructor
*/
class AutoFilter {
/**
* Gets the data sorter.
*/
getSorter() {
}
/**
* Represents the range to which the specified AutoFilter applies.
*/
getRange() {
}
/**
* Represents the range to which the specified AutoFilter applies.
*/
setRange(value) {
}
/**
* Indicates whether the AutoFilter button for this column is visible.
*/
getShowFilterButton() {
}
/**
* Indicates whether the AutoFilter button for this column is visible.
*/
setShowFilterButton(value) {
}
/**
* Gets the collection of the filter columns.
*/
getFilterColumns() {
}
/**
* Sets the range to which the specified AutoFilter applies.
* @param {Number} row - Row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endColumn - End column Index.
*/
setRange(row, startColumn, endColumn) {
}
/**
* Gets the CellArea where the specified AutoFilter applies to.
* @return {CellArea}
*/
getCellArea() {
}
/**
* Adds a filter for a filter column.
* MS Excel 2007 supports multiple selection in a filter column.
* @param {Number} 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 {String} criteria - The specified criteria (a string; for example, "101").
* It only can be null or be one of the cells' value in this column.
*/
addFilter(fieldIndex, criteria) {
}
/**
* Adds a date filter.
* If DateTimeGroupingType is Year, only the param year effects.
* If DateTiemGroupingType is Month, only the param year and month effect.
* @param {Number} 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 {Number} dateTimeGroupingType - DateTimeGroupingType
* @param {Number} year - The year.
* @param {Number} month - The month.
* @param {Number} day - The day.
* @param {Number} hour - The hour.
* @param {Number} minute - The minute.
* @param {Number} second - The second.
*/
addDateFilter(fieldIndex, dateTimeGroupingType, year, month, day, hour, minute, second) {
}
/**
* Removes a date filter.
* If DateTimeGroupingType is Year, only the param year effects.
* If DateTiemGroupingType is Month, only the param year and month effect.
* @param {Number} 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 {Number} dateTimeGroupingType - DateTimeGroupingType
* @param {Number} year - The year.
* @param {Number} month - The month.
* @param {Number} day - The day.
* @param {Number} hour - The hour.
* @param {Number} minute - The minute.
* @param {Number} second - The second.
*/
removeDateFilter(fieldIndex, dateTimeGroupingType, year, month, day, hour, minute, second) {
}
/**
* Removes a filter for a filter column.
* @param {Number} 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 {String} 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, criteria) {
}
/**
* Filters a list with specified criteria.
* Aspose.Cells will remove all other filter setting on this field as Ms Excel 97-2003.
* @param {Number} 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 {String} criteria - The specified criteria (a string; for example, "101").
*/
filter(fieldIndex, criteria) {
}
/**
* Filter the top 10 item in the list
* @param {Number} 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 {boolean} isTop - Indicates whether filter from top or bottom
* @param {boolean} isPercent - Indicates whether the items is percent or count
* @param {Number} itemCount - The item count
*/
filterTop10(fieldIndex, isTop, isPercent, itemCount) {
}
/**
* Adds a dynamic filter.
* @param {Number} 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 {Number} dynamicFilterType - DynamicFilterType
*/
dynamicFilter(fieldIndex, dynamicFilterType) {
}
/**
* Adds a font color filter.
* @param {Number} 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 {CellsColor} color - The
*/
addFontColorFilter(fieldIndex, color) {
}
/**
* Adds a fill color filter.
* @param {Number} 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 {Number} pattern - BackgroundType
* @param {CellsColor} foregroundColor - The foreground color.
* @param {CellsColor} backgroundColor - The background color.
*/
addFillColorFilter(fieldIndex, pattern, foregroundColor, backgroundColor) {
}
/**
* Adds an icon filter.
* Only supports to add the icon filter.
* Not supports checking which row is visible if the filter is icon filter.
* @param {Number} 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 {Number} iconSetType - IconSetType
* @param {Number} iconId - The icon id.
*/
addIconFilter(fieldIndex, iconSetType, iconId) {
}
/**
* Match all blank cell in the list.
* @param {Number} 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) {
}
/**
* Match all not blank cell in the list.
* @param {Number} 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) {
}
/**
* Filters a list with a custom criteria.
* @param {Number} 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 {Number} operatorType1 - FilterOperatorType
* @param {Object} criteria1 - The custom criteria
*/
custom(fieldIndex, operatorType1, criteria1) {
}
/**
* Filters a list with custom criteria.
* @param {Number} 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 {Number} operatorType1 - FilterOperatorType
* @param {Object} criteria1 - The custom criteria
* @param {boolean} isAnd
* @param {Number} operatorType2 - FilterOperatorType
* @param {Object} criteria2 - The custom criteria
*/
custom(fieldIndex, operatorType1, criteria1, isAnd, operatorType2, criteria2) {
}
/**
* Unhide all rows.
*/
showAll() {
}
/**
* Remove the specific filter.
* @param {Number} fieldIndex - The specific filter index
*/
removeFilter(fieldIndex) {
}
/**
* Refresh auto filters to hide or unhide the rows.
* @return {Number[]}
* Returns all hidden rows' indexes.
*/
refresh() {
}
/**
* Gets all hidden rows' indexes.
* @param {boolean} hideRows -
* If true, hide the filtered rows.
* @return {Number[]}
* Returns all hidden rows indexes.
*/
refresh(hideRows) {
}
}
/**
* Represents all auto fitter options.
*/
class AutoFitterOptions {
/**
*/
constructor() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
getDefaultEditLanguage() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
setDefaultEditLanguage(value) {
}
/**
* Indicates whether auto fit row height when the cells is merged in a row.
* The default value is false.
* NOTE: This member is now obsolete. Instead,
* please use AutoFitterOptions.AutoFitMergedCellsType property, instead.
* This property will be removed 12 months later since December 2018.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getAutoFitMergedCells() {
}
/**
* Indicates whether auto fit row height when the cells is merged in a row.
* The default value is false.
* NOTE: This member is now obsolete. Instead,
* please use AutoFitterOptions.AutoFitMergedCellsType property, instead.
* This property will be removed 12 months later since December 2018.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setAutoFitMergedCells(value) {
}
/**
* Gets and set the type of auto fitting row height of merged cells.
* The value of the property is AutoFitMergedCellsType integer constant.
* 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() {
}
/**
* Gets and set the type of auto fitting row height of merged cells.
* The value of the property is AutoFitMergedCellsType integer constant.
* 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) {
}
/**
* Indicates whether only fit the rows which height are not customed.
*/
getOnlyAuto() {
}
/**
* Indicates whether only fit the rows which height are not customed.
*/
setOnlyAuto(value) {
}
/**
* Ignores the hidden rows/columns.
*/
getIgnoreHidden() {
}
/**
* Ignores the hidden rows/columns.
*/
setIgnoreHidden(value) {
}
/**
* Gets and sets the max row height(in unit of Point) when autofitting rows.
*/
getMaxRowHeight() {
}
/**
* Gets and sets the max row height(in unit of Point) when autofitting rows.
*/
setMaxRowHeight(value) {
}
/**
* Gets and sets the type of auto fitting wrapped text.
* The value of the property is AutoFitWrappedTextType integer constant.
*/
getAutoFitWrappedTextType() {
}
/**
* Gets and sets the type of auto fitting wrapped text.
* The value of the property is AutoFitWrappedTextType integer constant.
*/
setAutoFitWrappedTextType(value) {
}
/**
* Gets and sets the formatted strategy.
* The value of the property is CellValueFormatStrategy integer constant.
* The default value is CellStyle for performance.
*/
getFormatStrategy() {
}
/**
* Gets and sets the formatted strategy.
* The value of the property is CellValueFormatStrategy integer constant.
* The default value is CellStyle for performance.
*/
setFormatStrategy(value) {
}
/**
* Indicates whether fit for rendering purpose.
*/
getForRendering() {
}
/**
* Indicates whether fit for rendering purpose.
*/
setForRendering(value) {
}
}
/**
* represents automatic fill.
* @hideconstructor
*/
class AutomaticFill {
/**
* /
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* Represents automatic numbered bullet.
*/
class AutoNumberedBulletValue {
/**
*/
constructor() {
}
/**
* Gets the type of the bullet.
* The value of the property is BulletType integer constant.
*/
getType() {
}
/**
* Gets and sets the starting number of the bullet.
*/
getStartAt() {
}
/**
* Gets and sets the starting number of the bullet.
*/
setStartAt(value) {
}
/**
* Represents the scheme of automatic number.
* The value of the property is TextAutonumberScheme integer constant.
*/
getAutonumberScheme() {
}
/**
* Represents the scheme of automatic number.
* The value of the property is TextAutonumberScheme integer constant.
*/
setAutonumberScheme(value) {
}
}
/**
* Encapsulates the object that represents an axis of chart.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Excel object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(4);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(20);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 25, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
* chart.getNSeries().add("A1:B3", true);
* //Set the max value of value axis
* chart.getValueAxis().setMaxValue(200);
* //Set the min value of value axis
* chart.getValueAxis().setMinValue(0);
* //Set the major unit
* chart.getValueAxis().setMajorUnit(25);
* //Category(X) axis crosses at the maxinum value.
* chart.getValueAxis().setCrossType(aspose.cells.CrossType.MAXIMUM);
* //Set he number of categories or series between tick-mark labels.
* chart.getCategoryAxis().setTickLabelSpacing(2);
* //Saving the Excel file
* workbook.save("Book1.xlsx");
* @hideconstructor
*/
class Axis {
/**
* Gets the Area.
*/
getArea() {
}
/**
* Indicates whether the min value is automatically assigned.
*/
isAutomaticMinValue() {
}
/**
* Indicates whether the min value is automatically assigned.
*/
setAutomaticMinValue(value) {
}
/**
* Represents the minimum value on the value axis.
* The minValue type only can be double or DateTime
*/
getMinValue() {
}
/**
* Represents the minimum value on the value axis.
* The minValue type only can be double or DateTime
*/
setMinValue(value) {
}
/**
* Indicates whether the max value is automatically assigned.
*/
isAutomaticMaxValue() {
}
/**
* Indicates whether the max value is automatically assigned.
*/
setAutomaticMaxValue(value) {
}
/**
* Represents the maximum value on the value axis.
* The maxValue type only can be double or DateTime
*/
getMaxValue() {
}
/**
* Represents the maximum value on the value axis.
* The maxValue type only can be double or DateTime
*/
setMaxValue(value) {
}
/**
* Indicates whether the major unit of the axis is automatically assigned.
*/
isAutomaticMajorUnit() {
}
/**
* Indicates whether the major unit of the axis is automatically assigned.
*/
setAutomaticMajorUnit(value) {
}
/**
* Represents the major units for the axis.
* The major units must be greater than zero.
*/
getMajorUnit() {
}
/**
* Represents the major units for the axis.
* The major units must be greater than zero.
*/
setMajorUnit(value) {
}
/**
* Indicates whether the minor unit of the axis is automatically assigned.
*/
isAutomaticMinorUnit() {
}
/**
* Indicates whether the minor unit of the axis is automatically assigned.
*/
setAutomaticMinorUnit(value) {
}
/**
* Represents the minor units for the axis.
* The minor units must be greater than zero.
*/
getMinorUnit() {
}
/**
* Represents the minor units for the axis.
* The minor units must be greater than zero.
*/
setMinorUnit(value) {
}
/**
* Gets the appearance of an Axis.
*/
getAxisLine() {
}
/**
* Represents the type of major tick mark for the specified axis.
* The value of the property is TickMarkType integer constant.
*/
getMajorTickMark() {
}
/**
* Represents the type of major tick mark for the specified axis.
* The value of the property is TickMarkType integer constant.
*/
setMajorTickMark(value) {
}
/**
* Represents the type of minor tick mark for the specified axis.
* The value of the property is TickMarkType integer constant.
*/
getMinorTickMark() {
}
/**
* Represents the type of minor tick mark for the specified axis.
* The value of the property is TickMarkType integer constant.
*/
setMinorTickMark(value) {
}
/**
* Represents the position of tick-mark labels on the specified axis.
* The value of the property is TickLabelPositionType integer constant.
*/
getTickLabelPosition() {
}
/**
* Represents the position of tick-mark labels on the specified axis.
* The value of the property is TickLabelPositionType integer constant.
*/
setTickLabelPosition(value) {
}
/**
* Represents the point on the value axis where the category axis crosses it.
* The number should be a integer when it applies to category axis.
* And the value must be between 1 and 31999.
*/
getCrossAt() {
}
/**
* Represents the point on the value axis where the category axis crosses it.
* The number should be a integer when it applies to category axis.
* And the value must be between 1 and 31999.
*/
setCrossAt(value) {
}
/**
* Represents the CrossType on the specified axis where the other axis crosses.
* The value of the property is CrossType integer constant.
*/
getCrossType() {
}
/**
* Represents the CrossType on the specified axis where the other axis crosses.
* The value of the property is CrossType integer constant.
*/
setCrossType(value) {
}
/**
* Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
*/
getLogBase() {
}
/**
* Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
*/
setLogBase(value) {
}
/**
* Represents if the value axis scale type is logarithmic or not.
*/
isLogarithmic() {
}
/**
* Represents if the value axis scale type is logarithmic or not.
*/
setLogarithmic(value) {
}
/**
* Represents if Microsoft Excel plots data points from last to first.
*/
isPlotOrderReversed() {
}
/**
* Represents if Microsoft Excel plots data points from last to first.
*/
setPlotOrderReversed(value) {
}
/**
* Represents if the value axis crosses the category axis between categories.
* This property applies only to category axes, and it doesn't apply to 3-D charts.
*/
getAxisBetweenCategories() {
}
/**
* Represents if the value axis crosses the category axis between categories.
* This property applies only to category axes, and it doesn't apply to 3-D charts.
*/
setAxisBetweenCategories(value) {
}
/**
* Returns a TickLabels object that represents the tick-mark labels for the specified axis.
*/
getTickLabels() {
}
/**
* Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
* The number must be between 1 and 31999.
*/
getTickLabelSpacing() {
}
/**
* Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
* The number must be between 1 and 31999.
*/
setTickLabelSpacing(value) {
}
/**
* Indicates whether the spacing of tick label is automatic
*/
isAutoTickLabelSpacing() {
}
/**
* Indicates whether the spacing of tick label is automatic
*/
setAutoTickLabelSpacing(value) {
}
/**
* Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
* The number must be between 1 and 31999.
*/
getTickMarkSpacing() {
}
/**
* Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
* The number must be between 1 and 31999.
*/
setTickMarkSpacing(value) {
}
/**
* Represents the unit label for the specified axis.
* The value of the property is DisplayUnitType integer constant.
*/
getDisplayUnit() {
}
/**
* Represents the unit label for the specified axis.
* The value of the property is DisplayUnitType integer constant.
*/
setDisplayUnit(value) {
}
/**
* Specifies a custom value for the display unit.
* NOTE: This property is now obsolete. Instead,
* please use Axis.CustomUnit property.
* This property will be removed 12 months later since January 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getCustUnit() {
}
/**
* Specifies a custom value for the display unit.
* NOTE: This property is now obsolete. Instead,
* please use Axis.CustomUnit property.
* This property will be removed 12 months later since January 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCustUnit(value) {
}
/**
* Specifies a custom value for the display unit.
*/
getCustomUnit() {
}
/**
* Specifies a custom value for the display unit.
*/
setCustomUnit(value) {
}
/**
* Represents a unit label on an axis in the specified chart.
* Unit labels are useful for charting large values— for example, in the millions or billions.
*/
getDisplayUnitLabel() {
}
/**
* Represents if the display unit label is shown on the specified axis.
* The default value is True.
*/
isDisplayUnitLabelShown() {
}
/**
* Represents if the display unit label is shown on the specified axis.
* The default value is True.
*/
setDisplayUnitLabelShown(value) {
}
/**
* Gets the axis' title.
*/
getTitle() {
}
/**
* Represents the category axis type.
* The value of the property is CategoryType integer constant.
*/
getCategoryType() {
}
/**
* Represents the category axis type.
* The value of the property is CategoryType integer constant.
*/
setCategoryType(value) {
}
/**
* Represents the base unit scale for the category axis.
* The value of the property is TimeUnit integer constant.Setting this property only takes effect when the CategoryType property is set to TimeScale.
*/
getBaseUnitScale() {
}
/**
* Represents the base unit scale for the category axis.
* The value of the property is TimeUnit integer constant.Setting this property only takes effect when the CategoryType property is set to TimeScale.
*/
setBaseUnitScale(value) {
}
/**
* Represents whether the base unit is automatic.
*/
isBaseUnitAuto() {
}
/**
* Represents whether the base unit is automatic.
*/
setBaseUnitAuto(value) {
}
/**
* Represents the major unit scale for the category axis.
* The value of the property is TimeUnit integer constant.
* @example
* chart.getCategoryAxis().setCategoryType(aspose.cells.CategoryType.TIME_SCALE);
* chart.getCategoryAxis().setMajorUnitScale(aspose.cells.TimeUnit.MONTHS);
* chart.getCategoryAxis().setMajorUnit(2);
*/
getMajorUnitScale() {
}
/**
* Represents the major unit scale for the category axis.
* The value of the property is TimeUnit integer constant.
* @example
* chart.getCategoryAxis().setCategoryType(aspose.cells.CategoryType.TIME_SCALE);
* chart.getCategoryAxis().setMajorUnitScale(aspose.cells.TimeUnit.MONTHS);
* chart.getCategoryAxis().setMajorUnit(2);
*/
setMajorUnitScale(value) {
}
/**
* Represents the major unit scale for the category axis.
* The value of the property is TimeUnit integer constant.
* @example
* chart.getCategoryAxis().setCategoryType(aspose.cells.CategoryType.TIME_SCALE);
* chart.getCategoryAxis().setMinorUnitScale(aspose.cells.TimeUnit.MONTHS);
* chart.getCategoryAxis().setMinorUnit(2);
*/
getMinorUnitScale() {
}
/**
* Represents the major unit scale for the category axis.
* The value of the property is TimeUnit integer constant.
* @example
* chart.getCategoryAxis().setCategoryType(aspose.cells.CategoryType.TIME_SCALE);
* chart.getCategoryAxis().setMinorUnitScale(aspose.cells.TimeUnit.MONTHS);
* chart.getCategoryAxis().setMinorUnit(2);
*/
setMinorUnitScale(value) {
}
/**
* Represents if the axis is visible.
*/
isVisible() {
}
/**
* Represents if the axis is visible.
*/
setVisible(value) {
}
/**
* Represents major gridlines on a chart axis.
* @example
* chart.getValueAxis().getMajorGridLines().setVisible(false);
* chart.getCategoryAxis().getMajorGridLines().setVisible(true);
*/
getMajorGridLines() {
}
/**
* Represents minor gridlines on a chart axis.
*/
getMinorGridLines() {
}
/**
* Indicates whether the labels shall be shown as multi level.
* Only valid for category axis.
*/
hasMultiLevelLabels() {
}
/**
* Indicates whether the labels shall be shown as multi level.
* Only valid for category axis.
*/
setHasMultiLevelLabels(value) {
}
/**
* Gets the labels of the axis after call Chart.Calculate() method.
* NOTE: This member is now obsolete. Instead,
* please use Axis.GetAxisTexts method.
* This property will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getAxisLabels() {
}
/**
* Represents bins on a chart(Histogram/Pareto) axis
*/
getBins() {
}
/**
* Gets the labels of the axis after call Chart.Calculate() method.
*/
getAxisTexts() {
}
}
/**
* Represents axis bins
* @hideconstructor
*/
class AxisBins {
/**
* Indicates whether grouping data by category
*/
isByCategory() {
}
/**
* Indicates whether grouping data by category
*/
setByCategory(value) {
}
/**
* Indicates whether the axis bins are automatic.
*/
isAutomatic() {
}
/**
* Indicates whether the axis bins are automatic.
*/
setAutomatic(value) {
}
/**
* Gets or sets the width of axis bin
*/
getWidth() {
}
/**
* Gets or sets the width of axis bin
*/
setWidth(value) {
}
/**
* Gets or set the count of axis bins
*/
getCount() {
}
/**
* Gets or set the count of axis bins
*/
setCount(value) {
}
/**
* Gets or set the overflow of axis bins
*/
getOverflow() {
}
/**
* Gets or set the overflow of axis bins
*/
setOverflow(value) {
}
/**
* Gets or set the underflow of axis bins
*/
getUnderflow() {
}
/**
* Gets or set the underflow of axis bins
*/
setUnderflow(value) {
}
/**
* Reset the overflow
*/
resetOverflow() {
}
/**
* Reset the underflow
*/
resetUnderflow() {
}
}
/**
* This class specifies the bar equation, consisting of a base argument and an overbar or underbar.
* @hideconstructor
*/
class BarEquationNode {
/**
* This attribute specifies the position of the bar in the bar object
* The value of the property is EquationCharacterPositionType integer constant.
*/
getBarPosition() {
}
/**
* This attribute specifies the position of the bar in the bar object
* The value of the property is EquationCharacterPositionType integer constant.
*/
setBarPosition(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents the shape guide.
* @hideconstructor
*/
class BaseShapeGuide {
}
/**
* Represents a bevel of a shape
* @hideconstructor
*/
class Bevel {
/**
* Gets and sets the width of the bevel, or how far into the shape it is applied.
* In unit of Points.
*/
getWidth() {
}
/**
* Gets and sets the width of the bevel, or how far into the shape it is applied.
* In unit of Points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the bevel, or how far above the shape it is applied.
* In unit of Points.
*/
getHeight() {
}
/**
* Gets and sets the height of the bevel, or how far above the shape it is applied.
* In unit of Points.
*/
setHeight(value) {
}
/**
* Gets and sets the preset bevel type.
* The value of the property is BevelPresetType integer constant.
*/
getType() {
}
/**
* Gets and sets the preset bevel type.
* The value of the property is BevelPresetType integer constant.
*/
setType(value) {
}
}
/**
* Encapsulates the object that represents the cell border.
* @example
* var workbook = new aspose.cells.Workbook();
* var worksheet = workbook.getWorksheets().get(0);
* var cell = worksheet.getCells().get(0, 0);
* var style = workbook.createStyle();
* //Set top border style and color
* var border = style.getBorders().getByBorderType(aspose.cells.BorderType.TOP_BORDER);
* border.setLineStyle(aspose.cells.CellBorderType.MEDIUM);
* border.setColor(aspose.cells.Color.getRed());
* cell.setStyle(style);
* @hideconstructor
*/
class Border {
/**
* Gets and sets the theme color of the border.
*/
getThemeColor() {
}
/**
* Gets and sets the theme color of the border.
*/
setThemeColor(value) {
}
/**
* Gets or sets the com.aspose.cells.Color of the border.
*/
getColor() {
}
/**
* Gets or sets the com.aspose.cells.Color of the border.
*/
setColor(value) {
}
/**
* Gets and sets the color with a 32-bit ARGB value.
*/
getArgbColor() {
}
/**
* Gets and sets the color with a 32-bit ARGB value.
*/
setArgbColor(value) {
}
/**
* Gets or sets the cell border type.
* The value of the property is CellBorderType integer constant.
*/
getLineStyle() {
}
/**
* Gets or sets the cell border type.
* The value of the property is CellBorderType integer constant.
*/
setLineStyle(value) {
}
}
/**
* This class specifies the Border Box function, consisting of a border drawn around an equation.
* @hideconstructor
*/
class BorderBoxEquationNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Encapsulates a collection of Border objects.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(0);
* //Accessing the "A1" cell from the worksheet
* var cell = worksheet.getCells().get("A1");
* //Adding some value to the "A1" cell
* cell.putValue("Visit Aspose!");
* //Get style object from cell
* var style = cell.getStyle();
* //Setting the line style of the top border
* style.getBorders().getByBorderType(aspose.cells.BorderType.TOP_BORDER).setLineStyle(aspose.cells.CellBorderType.THICK);
* //Setting the color of the top border
* style.getBorders().getByBorderType(aspose.cells.BorderType.TOP_BORDER).setColor(aspose.cells.Color.getBlack());
* //Setting the line style of the bottom border
* style.getBorders().getByBorderType(aspose.cells.BorderType.BOTTOM_BORDER).setLineStyle(aspose.cells.CellBorderType.THICK);
* //Setting the color of the bottom border
* style.getBorders().getByBorderType(aspose.cells.BorderType.BOTTOM_BORDER).setColor(aspose.cells.Color.getBlack());
* //Setting the line style of the left border
* style.getBorders().getByBorderType(aspose.cells.BorderType.LEFT_BORDER).setLineStyle(aspose.cells.CellBorderType.THICK);
* //Setting the color of the left border
* style.getBorders().getByBorderType(aspose.cells.BorderType.LEFT_BORDER).setColor(aspose.cells.Color.getBlack());
* //Setting the line style of the right border
* style.getBorders().getByBorderType(aspose.cells.BorderType.RIGHT_BORDER).setLineStyle(aspose.cells.CellBorderType.THICK);
* //Setting the color of the right border
* style.getBorders().getByBorderType(aspose.cells.BorderType.RIGHT_BORDER).setColor(aspose.cells.Color.getBlack());
* //Set style object to cell
* cell.setStyle(style);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class BorderCollection {
/**
* Gets or sets the com.aspose.cells.Color of Diagonal lines.
*/
getDiagonalColor() {
}
/**
* Gets or sets the com.aspose.cells.Color of Diagonal lines.
*/
setDiagonalColor(value) {
}
/**
* Gets or sets the style of Diagonal lines.
* The value of the property is CellBorderType integer constant.
*/
getDiagonalStyle() {
}
/**
* Gets or sets the style of Diagonal lines.
* The value of the property is CellBorderType integer constant.
*/
setDiagonalStyle(value) {
}
/**
* Gets the Border element at the specified index.
* @param {Number} borderType - BorderType
* @return {Border} The element at the specified index.
*/
getByBorderType(borderType) {
}
/**
* Sets the com.aspose.cells.Color of all borders in the collection.
* @param {Color} color - Borders'
*/
setColor(color) {
}
/**
* Sets the style of all borders of the collection.
* @param {Number} style - CellBorderType
*/
setStyle(style) {
}
}
/**
* This class specifies the box function, which is used to group components of an equation.
* @hideconstructor
*/
class BoxEquationNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* A collection of built-in document properties.
* Provides access to DocumentProperty objects by their names (using an indexer) and
* via a set of typed properties that return values of appropriate types.
* @hideconstructor
*/
class BuiltInDocumentPropertyCollection {
/**
* Gets or sets the document's language.
*/
getLanguage() {
}
/**
* Gets or sets the document's language.
*/
setLanguage(value) {
}
/**
* Gets or sets the name of the document's author.
*/
getAuthor() {
}
/**
* Gets or sets the name of the document's author.
*/
setAuthor(value) {
}
/**
* Represents an estimate of the number of bytes in the document.
*/
getBytes() {
}
/**
* Represents an estimate of the number of bytes in the document.
*/
setBytes(value) {
}
/**
* Represents an estimate of the number of characters in the document.
*/
getCharacters() {
}
/**
* Represents an estimate of the number of characters in the document.
*/
setCharacters(value) {
}
/**
* Represents an estimate of the number of characters (including spaces) in the document.
*/
getCharactersWithSpaces() {
}
/**
* Represents an estimate of the number of characters (including spaces) in the document.
*/
setCharactersWithSpaces(value) {
}
/**
* Gets or sets the document comments.
*/
getComments() {
}
/**
* Gets or sets the document comments.
*/
setComments(value) {
}
/**
* Gets or sets the category of the document.
*/
getCategory() {
}
/**
* Gets or sets the category of the document.
*/
setCategory(value) {
}
/**
* Gets or sets the content type of the document.
*/
getContentType() {
}
/**
* Gets or sets the content type of the document.
*/
setContentType(value) {
}
/**
* Gets or sets the content status of the document.
*/
getContentStatus() {
}
/**
* Gets or sets the content status of the document.
*/
setContentStatus(value) {
}
/**
* Gets or sets the company property.
*/
getCompany() {
}
/**
* Gets or sets the company property.
*/
setCompany(value) {
}
/**
* Gets or sets the hyperlinkbase property.
*/
getHyperlinkBase() {
}
/**
* Gets or sets the hyperlinkbase property.
*/
setHyperlinkBase(value) {
}
/**
* Gets or sets date of the document creation in local timezone.
* Aspose.Cells does not update this property when you modify the document.
*/
getCreatedTime() {
}
/**
* Gets or sets date of the document creation in local timezone.
* Aspose.Cells does not update this property when you modify the document.
*/
setCreatedTime(value) {
}
/**
* Gets or sets the Universal time of the document creation.
* Aspose.Cells does not update this property when you modify the document.
*/
getCreatedUniversalTime() {
}
/**
* Gets or sets the Universal time of the document creation.
* Aspose.Cells does not update this property when you modify the document.
*/
setCreatedUniversalTime(value) {
}
/**
* Gets or sets the document keywords.
*/
getKeywords() {
}
/**
* Gets or sets the document keywords.
*/
setKeywords(value) {
}
/**
* Gets or sets the date when the document was last printed in local timezone.
* If the document was never printed, this property will return DateTime.MinValue.Aspose.Cells does not update this property when you modify the document.
*/
getLastPrinted() {
}
/**
* Gets or sets the date when the document was last printed in local timezone.
* If the document was never printed, this property will return DateTime.MinValue.Aspose.Cells does not update this property when you modify the document.
*/
setLastPrinted(value) {
}
/**
* Gets or sets the Universal time when the document was last printed.
*/
getLastPrintedUniversalTime() {
}
/**
* Gets or sets the Universal time when the document was last printed.
*/
setLastPrintedUniversalTime(value) {
}
/**
* Gets or sets the name of the last author.
* Aspose.Cells does not update this property when you modify the document.
*/
getLastSavedBy() {
}
/**
* Gets or sets the name of the last author.
* Aspose.Cells does not update this property when you modify the document.
*/
setLastSavedBy(value) {
}
/**
* Gets or sets the time of the last save in local timezone.
* Aspose.Cells does not update this property when you modify the document.
*/
getLastSavedTime() {
}
/**
* Gets or sets the time of the last save in local timezone.
* Aspose.Cells does not update this property when you modify the document.
*/
setLastSavedTime(value) {
}
/**
* Gets or sets the universal time of the last save.
* Aspose.Cells does not update this property when you modify the document.
*/
getLastSavedUniversalTime() {
}
/**
* Gets or sets the universal time of the last save.
* Aspose.Cells does not update this property when you modify the document.
*/
setLastSavedUniversalTime(value) {
}
/**
* Represents an estimate of the number of lines in the document.
* Aspose.Cells does not update this property when you modify the document.
*/
getLines() {
}
/**
* Represents an estimate of the number of lines in the document.
* Aspose.Cells does not update this property when you modify the document.
*/
setLines(value) {
}
/**
* Gets or sets the manager property.
*/
getManager() {
}
/**
* Gets or sets the manager property.
*/
setManager(value) {
}
/**
* Gets or sets the name of the application.
*/
getNameOfApplication() {
}
/**
* Gets or sets the name of the application.
*/
setNameOfApplication(value) {
}
/**
* Represents an estimate of the number of pages in the document.
*/
getPages() {
}
/**
* Represents an estimate of the number of pages in the document.
*/
setPages(value) {
}
/**
* Represents an estimate of the number of paragraphs in the document.
*/
getParagraphs() {
}
/**
* Represents an estimate of the number of paragraphs in the document.
*/
setParagraphs(value) {
}
/**
* Gets or sets the document revision number.
* Aspose.Cells does not update this property when you modify the document.
*/
getRevisionNumber() {
}
/**
* Gets or sets the document revision number.
* Aspose.Cells does not update this property when you modify the document.
*/
setRevisionNumber(value) {
}
/**
* Gets or sets the subject of the document.
*/
getSubject() {
}
/**
* Gets or sets the subject of the document.
*/
setSubject(value) {
}
/**
* Gets or sets the informational name of the document template.
*/
getTemplate() {
}
/**
* Gets or sets the informational name of the document template.
*/
setTemplate(value) {
}
/**
* Gets or sets the title of the document.
*/
getTitle() {
}
/**
* Gets or sets the title of the document.
*/
setTitle(value) {
}
/**
* Gets or sets the total editing time in minutes.
*/
getTotalEditingTime() {
}
/**
* Gets or sets the total editing time in minutes.
*/
setTotalEditingTime(value) {
}
/**
* Represents the version number of the application that created the document.
* It's format is "00.0000",for example : 12.0000
*/
getVersion() {
}
/**
* Represents the version number of the application that created the document.
* It's format is "00.0000",for example : 12.0000
*/
setVersion(value) {
}
/**
* Represents the version of the file.
*/
getDocumentVersion() {
}
/**
* Represents the version of the file.
*/
setDocumentVersion(value) {
}
/**
* Indicates the display mode of the document thumbnail.
*/
getScaleCrop() {
}
/**
* Indicates the display mode of the document thumbnail.
*/
setScaleCrop(value) {
}
/**
* Indicates whether hyperlinks in a document are up-to-date.
*/
getLinksUpToDate() {
}
/**
* Indicates whether hyperlinks in a document are up-to-date.
*/
setLinksUpToDate(value) {
}
/**
* Represents an estimate of the number of words in the document.
*/
getWords() {
}
/**
* Represents an estimate of the number of words in the document.
*/
setWords(value) {
}
/**
*/
getCount() {
}
/**
* Returns a DocumentProperty object by the name of the property.
* The string names of the properties correspond to the names of the typed
* properties available from BuiltInDocumentPropertyCollection.If you request a property that is not present in the document, but the name
* of the property is recognized as a valid built-in name, a new DocumentProperty
* is created, added to the collection and returned. The newly created property is assigned
* a default value (empty string, zero, false or DateTime.MinValue depending on the type
* of the built-in property).If you request a property that is not present in the document and the name
* is not recognized as a built-in name, a null is returned.
* @param {String} name - The case-insensitive name of the property to retrieve.
*/
get(name) {
}
/**
* Returns a DocumentProperty object by index.
* @param {Number} index - Zero-based index of the
*/
get(index) {
}
/**
* Returns true if a property with the specified name exists in the collection.
* @param {String} name - The case-insensitive name of the property.
* @return {boolean} True if the property exists in the collection; false otherwise.
*/
contains(name) {
}
/**
* Gets the index of a property by name.
* @param {String} name - The case-insensitive name of the property.
* @return {Number} The zero based index. Negative value if not found.
*/
indexOf(name) {
}
/**
* Removes a property with the specified name from the collection.
* @param {String} name - The case-insensitive name of the property.
*/
remove(name) {
}
/**
* Removes a property at the specified index.
* @param {Number} index - The zero based index.
*/
removeAt(index) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the bullet points should be applied to a paragraph.
* @hideconstructor
*/
class Bullet {
/**
* Gets the value of bullet.
*/
getBulletValue() {
}
/**
* Gets and sets the type of bullet.
* The value of the property is BulletType integer constant.
*/
getType() {
}
/**
* Gets and sets the type of bullet.
* The value of the property is BulletType integer constant.
*/
setType(value) {
}
/**
* Get and sets the name of the font.
*/
getFontName() {
}
/**
* Get and sets the name of the font.
*/
setFontName(value) {
}
}
/**
* Represents the value of the bullet.
* @hideconstructor
*/
class BulletValue {
/**
* Gets the type of the bullet's value.
* The value of the property is BulletType integer constant.
*/
getType() {
}
}
/**
* Represents the Forms control: Button
* @example
* //Create a new Workbook.
* var workbook = new aspose.cells.Workbook();
* //Get the first worksheet in the workbook.
* var sheet = workbook.getWorksheets().get(0);
* //Add a new button to the worksheet.
* var button = sheet.getShapes().addShape(aspose.cells.MsoDrawingType.BUTTON, 2, 0, 2, 0, 28, 80);
* //Set the caption of the button.
* button.setText("Aspose");
* //Set the Placement Type, the way the
* //button is attached to the cells.
* button.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Set the font name.
* button.getFont().setName("Tahoma");
* //Set the caption string bold.
* button.getFont().setBold(true);
* //Set the color to blue.
* button.getFont().setColor(aspose.cells.Color.getBlue());
* //Set the hyperlink for the button.
* button.addHyperlink("http://www.aspose.com/");
* //Saves the file.
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Button {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents the calculation relevant data about one cell which is being calculated.
* 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.
* @hideconstructor
*/
class CalculationCell {
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets the Worksheet object where the cell is in.
*/
getWorksheet() {
}
/**
* Gets the row index of the cell.
*/
getCellRow() {
}
/**
* Gets the column index of the cell.
*/
getCellColumn() {
}
/**
* Gets the Cell object which is being calculated.
*/
getCell() {
}
/**
* Sets the calculated value for the cell.
* User can set the calculated result by this method to ignore the automatic calculation for the cell.
*/
setCalculatedValue(v) {
}
}
/**
* Represents the required data when calculating one function, such as function name, parameters, ...etc.
* 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.
* @hideconstructor
*/
class CalculationData {
/**
* Gets or sets the calculated value for this function.
* 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 Cell.Value,
* 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() {
}
/**
* Gets or sets the calculated value for this function.
* 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 Cell.Value,
* 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) {
}
/**
* Gets the Workbook object where the function is in.
*/
getWorkbook() {
}
/**
* Gets the Worksheet object where the function is in.
*/
getWorksheet() {
}
/**
* Gets the row index of the cell where the function is in.
*/
getCellRow() {
}
/**
* Gets the column index of the cell where the function is in.
*/
getCellColumn() {
}
/**
* Gets the Cell object where the function is in.
* When calculating a formula without setting it to a cell,
* such as by Worksheet.calculateFormula(java.lang.String, com.aspose.cells.CalculationOptions),
* the formula will be calculated just like it has been set to cell A1,
* so both CellRow and CellColumn 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() {
}
/**
* Gets the function name to be calculated.
*/
getFunctionName() {
}
/**
* Gets the count of parameters
*/
getParamCount() {
}
/**
* Gets the represented value object of the parameter at given index.
* 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 Workbook.updateCustomFunctionDefinition(com.aspose.cells.CustomFunctionDefinition)
* or FormulaParseOptions.CustomFunctionDefinition),
* then an array(object[][]) will be returned whose items are A1+B1,A2+B2,....
* @param {Number} index - The index of the parameter(0 based)
* @return {Object} The calculated value of the parameter.
*/
getParamValue(index) {
}
/**
* Gets the value(s) of the parameter at given index.
* If the parameter is some kind of expression that needs to be calculated,
* then it will be calculated in array mode.
* 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 Cells.MaxDataRow and Cells.MaxDataColumn),
* otherwise the returned large array may increase memory cost with large amount of useless data.
* @param {Number} index - The index of the parameter(0 based)
* @param {Number} 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 {Number} 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.
* @return {Object[][]} An array which contains all items represented by the specified parameter.
*/
getParamValueInArrayMode(index, maxRowCount, maxColumnCount) {
}
/**
* Gets the literal text of the parameter at given index.
* @param {Number} index - index of the parameter(0 based)
* @return {String} literal text of the parameter
*/
getParamText(index) {
}
}
/**
* Represents options for calculation.
*/
class CalculationOptions {
/**
*/
constructor() {
}
/**
* 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() {
}
/**
* Indicates whether errors encountered while calculating formulas should be ignored.
* The error may be unsupported function, external links, etc.
* The default value is true.
*/
setIgnoreError(value) {
}
/**
* Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells.
* The default value is true.
*/
getRecursive() {
}
/**
* Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells.
* The default value is true.
*/
setRecursive(value) {
}
/**
* The monitor for user to track the progress of formula calculation.
*/
getCalculationMonitor() {
}
/**
* The monitor for user to track the progress of formula calculation.
*/
setCalculationMonitor(value) {
}
/**
* The stack size for calculating cells recursively. Default value is 200.
* 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() {
}
/**
* The stack size for calculating cells recursively. Default value is 200.
* 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) {
}
/**
* Specifies the strategy for processing precision of calculation.
* The value of the property is CalculationPrecisionStrategy integer constant.
*/
getPrecisionStrategy() {
}
/**
* Specifies the strategy for processing precision of calculation.
* The value of the property is CalculationPrecisionStrategy integer constant.
*/
setPrecisionStrategy(value) {
}
/**
* Specifies the data sources for external links used in formulas.
* Like Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]), 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 Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]).
*/
getLinkedDataSources() {
}
/**
* Specifies the data sources for external links used in formulas.
* Like Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]), 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 Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]).
*/
setLinkedDataSources(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCharacterEncoding(value) {
}
}
/**
* Encapsulates the object that represents a single Workbook cell.
* @example
* var excel = new aspose.cells.Workbook();
* var cells = excel.getWorksheets().get(0).getCells();
* //Put a string into a cell
* var cell = cells.get(0, 0);
* cell.putValue("Hello");
* var first = cell.getStringValue();
* //Put an integer into a cell
* cell = cells.get("B1");
* cell.putValue(12);
* var second = cell.getIntValue();
* //Put a double into a cell
* cell = cells.get(0, 2);
* cell.putValue(-1.234);
* var third = cell.getDoubleValue();
* //Put a formula into a cell
* cell = cells.get("D1");
* cell.setFormula("=B1 + C1");
* //Put a combined formula: "sum(average(b1,c1), b1)" to cell at b2
* cell = cells.get("b2");
* cell.setFormula("=sum(average(b1,c1), b1)");
* //Set style of a cell
* var style = cell.getStyle();
* //Set background color
* style.setBackgroundColor(aspose.cells.Color.getYellow());
* //Set format of a cell
* style.getFont().setName("Courier New");
* style.setVerticalAlignment(aspose.cells.TextAlignmentType.TOP);
* cell.setStyle(style);
* @hideconstructor
*/
class Cell {
/**
* Gets the parent worksheet.
*/
getWorksheet() {
}
/**
* Gets the DateTime value contained in the cell.
*/
getDateTimeValue() {
}
/**
* Gets row number (zero based) of the cell.
* Cell row number
*/
getRow() {
}
/**
* Gets column number (zero based) of the cell.
*/
getColumn() {
}
/**
* Represents if the specified cell contains formula.
*/
isFormula() {
}
/**
* Represents cell value type.
* The value of the property is CellValueType integer constant.
*/
getType() {
}
/**
* Gets the name of the cell.
* 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() {
}
/**
* Checks if the value of this cell is an error.
* Also applies to formula cell to check whether the calculated result is an error.
*/
isErrorValue() {
}
/**
* Indicates whether the value of this cell is numeric(int, double and datetime)
* Also applies to formula cell to check the calculated result
*/
isNumericValue() {
}
/**
* 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() {
}
/**
* Gets cell's value as string without any format.
* NOTE: This method is now obsolete. Instead,
* User should get the value object and format it according to the value type and the specific requirement.
* This property will be removed 12 months later since December 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStringValueWithoutFormat() {
}
/**
* Represents the category type of this cell's number formatting.
* The value of the property is NumberCategoryType integer constant.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 NumberCategoryType.NUMBER;
* When cell's value is 0 or not numeric value, the returned type is NumberCategoryType.TEXT.
*/
getNumberCategoryType() {
}
/**
* Gets the formatted string value of this cell by cell's display style.
*/
getDisplayStringValue() {
}
/**
* Gets the integer value contained in the cell.
*/
getIntValue() {
}
/**
* Gets the double value contained in the cell.
*/
getDoubleValue() {
}
/**
* Gets the float value contained in the cell.
*/
getFloatValue() {
}
/**
* Gets the boolean value contained in the cell.
*/
getBoolValue() {
}
/**
* Indicates whether this cell has custom style settings(different from the default one inherited
* from corresponding row, column, or workbook).
*/
hasCustomStyle() {
}
/**
* Gets cell's shared style index in the style pool.
*/
getSharedStyleIndex() {
}
/**
* Gets or sets a formula of the Cell.
* A formula string always begins with an equal sign (=).
* And please always use comma(,) as parameters delimiter, such as "=SUM(A1, E1, H2)".
* @example
* var excel = new aspose.cells.Workbook();
* var cells = excel.getWorksheets().get(0).getCells();
* cells.get("B6").setFormula("=SUM(B2:B5, E1) + sheet2!A1");
*/
getFormula() {
}
/**
* Gets or sets a formula of the Cell.
* A formula string always begins with an equal sign (=).
* And please always use comma(,) as parameters delimiter, such as "=SUM(A1, E1, H2)".
* @example
* var excel = new aspose.cells.Workbook();
* var cells = excel.getWorksheets().get(0).getCells();
* cells.get("B6").setFormula("=SUM(B2:B5, E1) + sheet2!A1");
*/
setFormula(value) {
}
/**
* Get the locale formatted formula of the cell.
*/
getFormulaLocal() {
}
/**
* Get the locale formatted formula of the cell.
*/
setFormulaLocal(value) {
}
/**
* Gets or sets a R1C1 formula of the Cell.
*/
getR1C1Formula() {
}
/**
* Gets or sets a R1C1 formula of the Cell.
*/
setR1C1Formula(value) {
}
/**
* Indicates whether this cell contains an external link.
* Only applies when the cell is a formula cell.
*/
containsExternalLink() {
}
/**
* Indicates the cell's formula is an array formula
* and it is the first cell of the array.
*/
isArrayHeader() {
}
/**
* Indicates whether the cell's formula is dynamic array formula(true) or legacy array formula(false).
*/
isDynamicArrayFormula() {
}
/**
* Indicates whether the cell formula is an array formula.
*/
isArrayFormula() {
}
/**
* Indicates whether the cell formula is an array formula.
* NOTE: This class is now obsolete. Instead,
* please use Cell.IsArrayFormula to check whether the cell formula is an array formula.
* This property will be removed 12 months later since May 2018.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isInArray() {
}
/**
* Indicates whether the cell formula is part of shared formula.
*/
isSharedFormula() {
}
/**
* Indicates whether this cell is part of table formula.
*/
isTableFormula() {
}
/**
* Indicates whether this cell is part of table formula.
* NOTE: This class is now obsolete. Instead,
* please use Cell.IsTableFormula to check whether the cell formula is part of table formula.
* This property will be removed 12 months later since May 2018.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isInTable() {
}
/**
* Gets/sets the value contained in this cell.
* Possible type:
* null,Boolean,DateTime,Double,IntegerString.
* 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() {
}
/**
* Gets/sets the value contained in this cell.
* Possible type:
* null,Boolean,DateTime,Double,IntegerString.
* 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) {
}
/**
* Indicates if the cell's style is set. If return false, it means this cell has a default cell format.
*/
isStyleSet() {
}
/**
* Checks if a cell is part of a merged range or not.
*/
isMerged() {
}
/**
* Gets the comment of this cell.
* If there is no comment applies to the cell, returns null.
*/
getComment() {
}
/**
* Gets and sets the html string which contains data and some formats in this cell.
*/
getHtmlString() {
}
/**
* Gets and sets the html string which contains data and some formats in this cell.
*/
setHtmlString(value) {
}
/**
* Gets and sets the embeddedn image in the cell.
*/
getEmbeddedImage() {
}
/**
* Gets and sets the embeddedn image in the cell.
*/
setEmbeddedImage(value) {
}
/**
* Sets dynamic array formula and make the formula spill into neighboring cells if possible.
* @param {String} arrayFormula - the formula expression
* @param {FormulaParseOptions} options - options to parse formula.
* "Parse" option will be ignored and the formula will always be parsed immediately
* @param {boolean} calculateValue - whether calculate this dynamic array formula for those cells in the spilled range.
* @return {CellArea} the range that the formula should spill into.
*/
setDynamicArrayFormula(arrayFormula, options, calculateValue) {
}
/**
* Sets dynamic array formula and make the formula spill into neighboring cells if possible.
* @param {String} arrayFormula - the formula expression
* @param {FormulaParseOptions} options - options to parse formula.
* "Parse" option will be ignored and the formula will always be parsed immediately
* @param {Object[][]} values - values(calculated results) for those cells with given dynamic array formula
* @param {boolean} 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 {boolean} 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.
* @return {CellArea} the range that the formula should spill into.
*/
setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue) {
}
/**
* Sets dynamic array formula and make the formula spill into neighboring cells if possible.
* @param {String} arrayFormula - the formula expression
* @param {FormulaParseOptions} options - options to parse formula.
* "Parse" option will be ignored and the formula will always be parsed immediately
* @param {Object[][]} values - values(calculated results) for those cells with given dynamic array formula
* @param {boolean} 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 {boolean} 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 {CalculationOptions} copts - The options for calculating formula.
* Commonly, for performance consideration, the
* @return {CellArea} the range that the formula should spill into.
*/
setDynamicArrayFormula(arrayFormula, options, values, calculateRange, calculateValue, copts) {
}
/**
* Create two-variable data table for given range starting from this cell.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
* @param {String} rowInputCell - the row input cell
* @param {String} columnInputCell - the column input cell
* @param {Object[][]} values - values for cells in table formula range
*/
setTableFormula(rowNumber, columnNumber, rowInputCell, columnInputCell, values) {
}
/**
* Create one-variable data table for given range starting from this cell.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
* @param {String} inputCell - the input cell
* @param {boolean} isRowInput - Indicates whether the input cell is a row input cell(true) or a column input cell(false).
* @param {Object[][]} values - values for cells in table formula range
*/
setTableFormula(rowNumber, columnNumber, inputCell, isRowInput, values) {
}
/**
* Create two-variable data table for given range starting from this cell.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
* @param {Number} rowIndexOfRowInputCell - row index of the row input cell
* @param {Number} columnIndexOfRowInputCell - column index of the row input cell
* @param {Number} rowIndexOfColumnInputCell - row index of the column input cell
* @param {Number} columnIndexOfColumnInputCell - column index of the column input cell
* @param {Object[][]} values - values for cells in table formula range
*/
setTableFormula(rowNumber, columnNumber, rowIndexOfRowInputCell, columnIndexOfRowInputCell, rowIndexOfColumnInputCell, columnIndexOfColumnInputCell, values) {
}
/**
* Create one-variable data table for given range starting from this cell.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
* @param {Number} rowIndexOfInputCell - row index of the input cell
* @param {Number} columnIndexOfInputCell - column index of the input cell
* @param {boolean} isRowInput - Indicates whether the input cell is a row input cell(true) or a column input cell(false).
* @param {Object[][]} values - values for cells in table formula range
*/
setTableFormula(rowNumber, columnNumber, rowIndexOfInputCell, columnIndexOfInputCell, isRowInput, values) {
}
/**
* Remove array formula.
* @param {boolean} leaveNormalFormula - True represents converting the array formula to normal formula.
*/
removeArrayFormula(leaveNormalFormula) {
}
/**
* Copies data from a source cell.
* @param {Cell} cell - Source
*/
copy(cell) {
}
/**
* Returns a Characters object that represents a range of characters within the cell text.
* This method only works on cell with string value.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
* @example
* excel.getWorksheets().get(0).getCells().get("A1").putValue("Helloworld");
* excel.getWorksheets().get(0).getCells().get("A1").characters(5, 5).getFont().setBold(true);
* excel.getWorksheets().get(0).getCells().get("A1").characters(5, 5).getFont().setColor(aspose.cells.Color.getBlue());
*/
characters(startIndex, length) {
}
/**
* Replace text of the cell with options.
* @param {String} placeHolder - Cell placeholder
* @param {String} newValue - String value to replace
* @param {ReplaceOptions} options - The replace options
*/
replace(placeHolder, newValue, options) {
}
/**
* Insert some characters to the cell.
* If the cell is rich formatted, this method could keep the original formatting.
* @param {Number} index - The index.
* @param {String} text - Inserted text.
*/
insertText(index, text) {
}
/**
* Indicates whether the string value of this cell is a rich formatted text.
*/
isRichText() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the cell text.
* @return {FontSetting[]} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the cell text.
* @param {boolean} flag - Indicates whether applying table style to the cell if the cell is in the table.
* @return {FontSetting[]} All Characters objects
*/
getCharacters(flag) {
}
/**
* Sets rich text format of the cell.
* @param {FontSetting[]} characters - All Characters objects.
*/
setCharacters(characters) {
}
/**
* Returns a Range object which represents a merged range.
* @return {Range} Range object. Null if this cell is not merged.
*/
getMergedRange() {
}
/**
* Gets the html string which contains data and some formats in this cell.
* @param {boolean} html5 - Indicates whether the value is compatible for html5
* @return {String}
*/
getHtmlString(html5) {
}
/**
* Returns a string represents the current Cell object.
* @return {String}
*/
toString() {
}
/**
* Convert Cell to JSON struct data.
* @return {String}
*/
toJson() {
}
/**
* Checks whether this object refers to the same cell with another.
* @param {Object} obj - another object
* @return {boolean} true if two objects refers to the same cell.
*/
equals(obj) {
}
/**
* Serves as a hash function for a particular type.
* @return {Number} A hash code for current Cell object.
*/
hashCode() {
}
/**
* Checks whether this object refers to the same cell with another cell object.
* @param {Cell} cell - another cell object
* @return {boolean} true if two cell objects refers to the same cell.
*/
equals(cell) {
}
/**
* Get the result of the conditional formatting.
* Returns null if no conditional formatting is applied to this cell,
*/
getConditionalFormattingResult() {
}
/**
* Gets the validation applied to this cell.
* @return {Validation}
*/
getValidation() {
}
/**
* Gets the value of validation which applied to this cell.
* @return {boolean}
*/
getValidationValue() {
}
/**
* Gets the table which contains this cell.
* @return {ListObject}
*/
getTable() {
}
/**
* Calculates the formula of the cell.
* @param {CalculationOptions} options - Options for calculation
*/
calculate(options) {
}
/**
* Puts a boolean value into the cell.
* @param {boolean} boolValue
*/
putValue(boolValue) {
}
/**
* Puts an integer value into the cell.
* @param {Number} intValue - Input value
*/
putValue(intValue) {
}
/**
* Puts a double value into the cell.
* @param {Number} doubleValue - Input value
*/
putValue(doubleValue) {
}
/**
* 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 {String} stringValue - Input value
* @param {boolean} isConverted - True: converted to other data type if appropriate.
* @param {boolean} setStyle - True: set the number format to cell's style when converting to other data type
*/
putValue(stringValue, isConverted, setStyle) {
}
/**
* Puts a string value into the cell and converts the value to other data type if appropriate.
* @param {String} stringValue - Input value
* @param {boolean} isConverted - True: converted to other data type if appropriate.
*/
putValue(stringValue, isConverted) {
}
/**
* Puts a string value into the cell.
* @param {String} stringValue - Input value
*/
putValue(stringValue) {
}
/**
* Puts a DateTime value into the cell.
* 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.
* @param {DateTime} dateTime - Input value
*/
putValue(dateTime) {
}
/**
* Puts an object value into the cell.
* @param {Object} objectValue - input value
*/
putValue(objectValue) {
}
/**
* Gets the string value by specific formatted strategy.
* @param {Number} formatStrategy - CellValueFormatStrategy
* @return {String}
*/
getStringValue(formatStrategy) {
}
/**
* Gets the width of the value in unit of pixels.
* @return {Number}
*/
getWidthOfValue() {
}
/**
* Gets the height of the value in unit of pixels.
* @return {Number}
*/
getHeightOfValue() {
}
/**
* Gets the display style of the cell.
* If this cell is also affected by other settings such as conditional formatting, list objects, etc.,
* then the display style may be different from cell.GetStyle().
*/
getDisplayStyle() {
}
/**
* Gets the display style of the cell.
* If the cell is conditional formatted, the display style is not same as the cell.GetStyle().
* @param {boolean} includeMergedBorders - Indicates whether checking borders of the merged cells.
*/
getDisplayStyle(includeMergedBorders) {
}
/**
* Gets format conditions which applies to this cell.
* @return {FormatConditionCollection[]} Returns FormatConditionCollection object
*/
getFormatConditions() {
}
/**
* Gets the cell style.
* To change the style of the cell, please call Cell.SetStyle() method after modifying the returned style object.
* This method is same with getStyle(boolean) with true value for the parameter.
* @return {Style} Style object.
*/
getStyle() {
}
/**
* If checkBorders is true, check whether other cells' borders will effect the style of this cell.
* @param {boolean} checkBorders - Check other cells' borders
* @return {Style} Style object.
*/
getStyle(checkBorders) {
}
/**
* Sets the cell style.
* If the border settings are changed, the border of adjust cells will be updated too.
* @param {Style} style - The cell style.
*/
setStyle(style) {
}
/**
* Apply the changed property of style to the cell.
* @param {Style} style - The cell style.
* @param {boolean} explicitFlag - True, only overwriting formatting which is explicitly set.
*/
setStyle(style, explicitFlag) {
}
/**
* Apply the cell style based on flags.
* @param {Style} style - The cell style.
* @param {StyleFlag} flag - The style flag.
*/
setStyle(style, flag) {
}
/**
* Set the formula and the value(calculated result) of the formula.
* @param {String} formula - The formula.
* @param {Object} value - The value(calculated result) of the formula.
*/
setFormula(formula, value) {
}
/**
* Get the formula of this cell.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} the formula of this cell.
*/
getFormula(isR1C1, isLocal) {
}
/**
* Set the formula and the value of the formula.
* NOTE: This class is now obsolete. Instead,
* please use Cell.SetFormula(string,FormulaParseOptions,object).
* This property will be removed 12 months later since December 2019.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} formula - The formula.
* @param {boolean} isR1C1 - Whether the formula is R1C1 formula.
* @param {boolean} isLocal - Whether the formula is locale formatted.
* @param {Object} value - The value of the formula.
*/
setFormula(formula, isR1C1, isLocal, value) {
}
/**
* Set the formula and the value(calculated result) of the formula.
* @param {String} formula - The formula.
* @param {FormulaParseOptions} options - Options for parsing the formula.
* @param {Object} value - The value(calculated result) of the formula.
*/
setFormula(formula, options, value) {
}
/**
* Sets an array formula to a range of cells.
* NOTE: This class is now obsolete. Instead,
* please use Cell.SetArrayFormula(string,int,int,FormulaParseOptions).
* This property will be removed 12 months later since December 2019.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} arrayFormula - Array formula.
* @param {Number} rowNumber - Number of rows to populate result of the array formula.
* @param {Number} columnNumber - Number of columns to populate result of the array formula.
* @param {boolean} isR1C1 - whether the formula is R1C1 formula
* @param {boolean} isLocal - whether the formula is locale formatted
*/
setArrayFormula(arrayFormula, rowNumber, columnNumber, isR1C1, isLocal) {
}
/**
* Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells.
* @param {String} arrayFormula - Array formula.
* @param {Number} rowNumber - Number of rows to populate result of the array formula.
* @param {Number} columnNumber - Number of columns to populate result of the array formula.
*/
setArrayFormula(arrayFormula, rowNumber, columnNumber) {
}
/**
* Sets an array formula to a range of cells.
* @param {String} arrayFormula - Array formula.
* @param {Number} rowNumber - Number of rows to populate result of the array formula.
* @param {Number} columnNumber - Number of columns to populate result of the array formula.
* @param {FormulaParseOptions} options - Options for parsing the formula.
*/
setArrayFormula(arrayFormula, rowNumber, columnNumber, options) {
}
/**
* Sets an array formula to a range of cells.
* @param {String} arrayFormula - Array formula.
* @param {Number} rowNumber - Number of rows to populate result of the array formula.
* @param {Number} columnNumber - Number of columns to populate result of the array formula.
* @param {FormulaParseOptions} options - Options for parsing the formula.
* @param {Object[][]} values - values for those cells with given array formula
*/
setArrayFormula(arrayFormula, rowNumber, columnNumber, options, values) {
}
/**
* Sets a formula to a range of cells.
* NOTE: This class is now obsolete. Instead,
* please use Cell.SetSharedFormula(string,int,int,FormulaParseOptions).
* This property will be removed 12 months later since December 2019.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} sharedFormula - Shared formula.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
* @param {boolean} isR1C1 - whether the formula is R1C1 formula
* @param {boolean} isLocal - whether the formula is locale formatted
*/
setSharedFormula(sharedFormula, rowNumber, columnNumber, isR1C1, isLocal) {
}
/**
* Sets shared formulas to a range of cells.
* @param {String} sharedFormula - Shared formula.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
*/
setSharedFormula(sharedFormula, rowNumber, columnNumber) {
}
/**
* Sets shared formulas to a range of cells.
* @param {String} sharedFormula - Shared formula.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
* @param {FormulaParseOptions} options - Options for parsing the formula.
*/
setSharedFormula(sharedFormula, rowNumber, columnNumber, options) {
}
/**
* Sets shared formulas to a range of cells.
* @param {String} sharedFormula - Shared formula.
* @param {Number} rowNumber - Number of rows to populate the formula.
* @param {Number} columnNumber - Number of columns to populate the formula.
* @param {FormulaParseOptions} options - Options for parsing the formula.
* @param {Object[][]} values - values for those cells with given shared formula
*/
setSharedFormula(sharedFormula, rowNumber, columnNumber, options, values) {
}
/**
* Gets all references appearing in this cell's formula.
* 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 getPrecedentsInCalculation().@return {ReferredAreaCollection}
* Collection of all references appearing in this cell's formula.
* @example
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* cells.get("A1").setFormula("= B1 + SUM(B1:B10) + [Book1.xls]Sheet1!A1");
* var areas = cells.get("A1").getPrecedents();
* for (var i = 0; i < areas.getCount(); i++)
* {
* var area = areas.get(i);
* var stringBuilder = "";
* if (area.isExternalLink())
* {
* stringBuilder += "[";
* stringBuilder += area.getExternalFileName();
* stringBuilder += "]";
* }
* stringBuilder += area.getSheetName();
* stringBuilder += "!";
* stringBuilder += aspose.cells.CellsHelper.cellIndexToName(area.getStartRow(), area.getStartColumn());
* if (area.isArea())
* {
* stringBuilder += ":";
* stringBuilder += aspose.cells.CellsHelper.cellIndexToName(area.getEndRow(), area.getEndColumn());
* }
* console.log(stringBuilder);
* }
* workbook.save("Book2.xls");
*/
getPrecedents() {
}
/**
* Get all cells whose formula references to this cell directly.
* 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 getDependentsInCalculation(boolean).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 getDependentsInCalculation(boolean) instead.
* Or, user may gather precedents map of all cells by getPrecedents() firstly,
* and then build the dependents map according to the precedents map.
* @param {boolean} isAll - Indicates whether check formulas in other worksheets
*/
getDependents(isAll) {
}
/**
* Gets all precedents(reference to cells in current workbook) used by this cell's formula while calculating it.
* This method can only work with the situation that FormulaSettings.EnableCalculationChain
* 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.
* @return {Iterator} Enumerator to enumerate all references(ReferredArea)
*/
getPrecedentsInCalculation() {
}
/**
* Gets all cells whose calculated result depends on this cell.
* To use this method, please make sure the workbook has been set with true value for
* FormulaSettings.EnableCalculationChain and has been fully calculated with this setting.
* If there is no formula reference to this cell, null will be returned.
* @param {boolean} recursive - Whether returns those dependents which do not reference to this cell directly
* but reference to other leafs of this cell
* @return {Iterator} Enumerator to enumerate all dependents(Cell objects)
*/
getDependentsInCalculation(recursive) {
}
/**
* Get all cells which reference to this cell directly and need to be updated when this cell is modified.
* NOTE: This class is now obsolete. Instead,
* please use Cell.GetDependentsInCalculation(bool) to get all dependents in calculation chain.
* This property will be removed 12 months later since May 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {Iterator} Enumerator to enumerate all dependents(Cell)
*/
getLeafs() {
}
/**
* Get all cells which will be updated when this cell is modified.
* NOTE: This class is now obsolete. Instead,
* please use Cell.GetDependentsInCalculation(bool) to get all dependents in calculation chain.
* This property will be removed 12 months later since May 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {boolean} recursive - Whether returns those leafs that do not reference to this cell directly
* but reference to other leafs of this cell
* @return {Iterator} Enumerator to enumerate all dependents(Cell)
*/
getLeafs(recursive) {
}
/**
* Gets the array range if the cell's formula is an array formula.
* Only applies when the cell's formula is an array formula@return {CellArea}
* The array range.
*/
getArrayRange() {
}
}
/**
* Represent an area of cells.
* @example
* //Create Cell Area
* var ca = new aspose.cells.CellArea();
* ca.StartRow = 0;
* ca.EndRow = 0;
* ca.StartColumn = 0;
* ca.EndColumn = 0;
*/
class CellArea {
/**
* Gets or set the start row of this area.
*/
StartRow
/**
* Gets or set the end row of this area.
*/
EndRow
/**
* Gets or set the start column of this area.
*/
StartColumn
/**
* Gets or set the end column of this area.
*/
EndColumn
/**
*/
constructor() {
}
/**
* Compare two CellArea objects according to their top-left corner.
* @param {Object} obj
* @return {Number} If two corners are in different rows, then compare their row index. Otherwise compare their column index.
* If two corners are same, then 0 will be returned.
*/
compareTo(obj) {
}
/**
* Returns a string represents the current cell area object.
* @return {String}
*/
toString() {
}
/**
* Creates a cell area.
* @param {Number} startRow - The start row.
* @param {Number} startColumn - The start column.
* @param {Number} endRow - The end row.
* @param {Number} endColumn - The end column.
* @return {CellArea} Return a CellArea.
*/
static createCellArea(startRow, startColumn, endRow, endColumn) {
}
/**
* Creates a cell area.
* @param {String} startCellName - The top-left cell of the range.
* @param {String} endCellName - The bottom-right cell of the range.
* @return {CellArea} Return a CellArea.
*/
static createCellArea(startCellName, endCellName) {
}
}
/**
* Encapsulates a collection of cell relevant objects, such as Cell, Row, ...etc.
* @example
* var excel = new aspose.cells.Workbook();
* var cells = excel.getWorksheets().get(0).getCells();
* //Set default row height
* cells.setStandardHeight(20);
* //Set row height
* cells.setRowHeight(2, 20.5);
* //Set default colum width
* cells.setStandardWidth(15);
* //Set column width
* cells.setColumnWidth(3, 12.57);
* //Merge cells
* cells.merge(5, 4, 2, 2);
* @hideconstructor
*/
class Cells {
/**
* Gets the list of fields of ods.
*/
getOdsCellFields() {
}
/**
* Gets the total count of instantiated Cell objects.
*/
getCount() {
}
/**
* Gets the total count of instantiated Cell objects.
*/
getCountLarge() {
}
/**
* Gets the collection of Row objects that represents the individual rows in this worksheet.
*/
getRows() {
}
/**
* Gets the collection of merged cells.
* In this collection, each item is a CellArea structure which represents an area of merged cells.
* NOTE: This method is now obsolete. Instead,
* please use Cells.GetMergedAreas() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getMergedCells() {
}
/**
* Gets or sets whether the cells data model should support Multi-Thread reading.
* Default value of this property is false.
* 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 Cell.StringValue, Cell.DisplayStringValue, .etc.).
* So, even with this property being set as true, those APIs still may give unexpected result for Multi-Thread reading.
*/
getMultiThreadReading() {
}
/**
* Gets or sets whether the cells data model should support Multi-Thread reading.
* Default value of this property is false.
* 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 Cell.StringValue, Cell.DisplayStringValue, .etc.).
* So, even with this property being set as true, those APIs still may give unexpected result for Multi-Thread reading.
*/
setMultiThreadReading(value) {
}
/**
* Gets or sets the memory usage option for this cells.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage option for this cells.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets and sets the default style of the worksheet.
*/
getStyle() {
}
/**
* Gets and sets the default style of the worksheet.
*/
setStyle(value) {
}
/**
* Gets or sets the default column width in the worksheet, in unit of inches.
*/
getStandardWidthInch() {
}
/**
* Gets or sets the default column width in the worksheet, in unit of inches.
*/
setStandardWidthInch(value) {
}
/**
* Gets or sets the default column width in the worksheet, in unit of pixels.
*/
getStandardWidthPixels() {
}
/**
* Gets or sets the default column width in the worksheet, in unit of pixels.
*/
setStandardWidthPixels(value) {
}
/**
* Gets or sets the default column width in the worksheet, in unit of characters.
*/
getStandardWidth() {
}
/**
* Gets or sets the default column width in the worksheet, in unit of characters.
*/
setStandardWidth(value) {
}
/**
* Gets or sets the default row height in this worksheet, in unit of points.
*/
getStandardHeight() {
}
/**
* Gets or sets the default row height in this worksheet, in unit of points.
*/
setStandardHeight(value) {
}
/**
* Gets or sets the default row height in this worksheet, in unit of pixels.
*/
getStandardHeightPixels() {
}
/**
* Gets or sets the default row height in this worksheet, in unit of pixels.
*/
setStandardHeightPixels(value) {
}
/**
* Gets or sets the default row height in this worksheet, in unit of inches.
*/
getStandardHeightInch() {
}
/**
* Gets or sets the default row height in this worksheet, in unit of inches.
*/
setStandardHeightInch(value) {
}
/**
* Gets or sets a value indicating whether all worksheet values are preserved as strings.
* Default is false.
*/
getPreserveString() {
}
/**
* Gets or sets a value indicating whether all worksheet values are preserved as strings.
* Default is false.
*/
setPreserveString(value) {
}
/**
* Minimum row index of cell which contains data or style.
*/
getMinRow() {
}
/**
* Maximum row index of cell which contains data or style.
* Return -1 if there is no cell which contains data or style in the worksheet.
*/
getMaxRow() {
}
/**
* 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).
*/
getMinColumn() {
}
/**
* 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).
* Return -1 if there is no cell.
*/
getMaxColumn() {
}
/**
* Minimum row index of cell which contains data.
*/
getMinDataRow() {
}
/**
* Maximum row index of cell which contains data.
* Return -1 if there is no cell which contains data.
*/
getMaxDataRow() {
}
/**
* Minimum column index of cell which contains data.
* -1 will be returned if there is no cell which contains data.
* This property needs to iterate and check all cells in a worksheet,
* so it is a time-consumed progress and should not be invoked repeatedly.
*/
getMinDataColumn() {
}
/**
* Maximum column index of cell which contains data.
* -1 will be returned if there is no cell which contains data.
* This property needs to iterate and check all cells in a worksheet,
* so it is a time-consumed progress and should not be invoked repeatedly.
*/
getMaxDataColumn() {
}
/**
* Indicates that row height and default font height matches
*/
isDefaultRowHeightMatched() {
}
/**
* Indicates that row height and default font height matches
*/
setDefaultRowHeightMatched(value) {
}
/**
* Indicates whether the row is default hidden.
*/
isDefaultRowHidden() {
}
/**
* Indicates whether the row is default hidden.
*/
setDefaultRowHidden(value) {
}
/**
* Gets the collection of Column objects that represents the individual columns in this worksheet.
*/
getColumns() {
}
/**
* Gets the collection of Range objects created at run time.
*/
getRanges() {
}
/**
* Gets the last cell in this worksheet.
* Returns null if there is no data in the worksheet.
*/
getLastCell() {
}
/**
* Gets the max range which includes data, merged cells and shapes.
* Reutrns null if the worksheet is empty since Aspose.Cells 21.5.2.
*/
getMaxDisplayRange() {
}
/**
* Gets the first cell in this worksheet.
* Returns null if there is no data in the worksheet.
*/
getFirstCell() {
}
/**
* Gets the Cell element at the specified cell row index and column index.
* @param {Number} row - Row index.
* @param {Number} column - Column index.
* @return {Cell} The Cell object.
* @example
* var cells = excel.getWorksheets().get(0).getCells();
* var cell = cells.get(0, 0); //Gets the cell at "A1"
*/
get(row, column) {
}
/**
* Gets the Cell element at the specified cell name.
* @param {String} cellName - Cell name,including its column letter and row number, for example A5.
* @return {Cell} A Cell object
* @example
* var cells = excel.getWorksheets().get(0).getCells();
* var cell = cells.get("A1"); //Gets the cell at "A1"
*/
get(cellName) {
}
/**
* Retrieves subtotals setting of the range.
* @param {CellArea} ca - The range
* @return {SubtotalSetting}
*/
retrieveSubtotalSetting(ca) {
}
/**
* Creates subtotals for the range.
* @param {CellArea} ca - The range
* @param {Number} groupBy - The field to group by, as a zero-based integer offset
* @param {Number} function - ConsolidationFunction
* @param {Number[]} totalList - An array of zero-based field offsets, indicating the fields to which the subtotals are added.
*/
subtotal(ca, groupBy, function_, totalList) {
}
/**
* Creates subtotals for the range.
* @param {CellArea} ca - The range
* @param {Number} groupBy - The field to group by, as a zero-based integer offset
* @param {Number} function - ConsolidationFunction
* @param {Number[]} totalList - An array of zero-based field offsets, indicating the fields to which the subtotals are added.
* @param {boolean} replace - Indicates whether replace the current subtotals
* @param {boolean} pageBreaks - Indicates whether add page break between groups
* @param {boolean} summaryBelowData - Indicates whether add summary below data.
*/
subtotal(ca, groupBy, function_, totalList, replace, pageBreaks, summaryBelowData) {
}
/**
* Removes all formula and replaces with the value of the formula.
*/
removeFormulas() {
}
/**
* Removes duplicate rows in the sheet.
*/
removeDuplicates() {
}
/**
* Removes duplicate values in the range.
* @param {Number} startRow - The start row.
* @param {Number} startColumn - The start column
* @param {Number} endRow - The end row index.
* @param {Number} endColumn - The end column index.
*/
removeDuplicates(startRow, startColumn, endRow, endColumn) {
}
/**
* Removes duplicate data of the range.
* @param {Number} startRow - The start row.
* @param {Number} startColumn - The start column
* @param {Number} endRow - The end row index.
* @param {Number} endColumn - The end column index.
* @param {boolean} hasHeaders - Indicates whether the range contains headers.
* @param {Number[]} columnOffsets - The column offsets.
*/
removeDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets) {
}
/**
* Converts all string data in the worksheet to numeric value if possible.
*/
convertStringToNumericValue() {
}
/**
* Get all cells which refer to the specific cell.
* @param {boolean} isAll - Indicates whether check other worksheets
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {Cell[]}
*/
getDependents(isAll, row, column) {
}
/**
* Gets all cells whose calculated result depends on specific cell.
* To use this method, please make sure the workbook has been set with true value for
* FormulaSettings.EnableCalculationChain 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 Cell.getDependentsInCalculation(boolean)
* @param {Number} row - Row index of the specific cell
* @param {Number} column - Column index of the specific cell.
* @param {boolean} recursive - Whether returns those dependents which do not reference to the specific cell directly
* but reference to other leafs of that cell.
* @return {Iterator} Enumerator to enumerate all dependents(Cell objects)
*/
getDependentsInCalculation(row, column, recursive) {
}
/**
* Get the style of given cell.
* @param {Number} row - row index
* @param {Number} column - column
* @return {Style} the style of given cell.
*/
getCellStyle(row, column) {
}
/**
* Gets the last row index of cell which contains data in the specified column.
* @param {Number} column - Column index.
* @return {Number} last row index.
*/
getLastDataRow(column) {
}
/**
* Applies formats for a whole column.
* @param {Number} column - The column index.
* @param {Style} style - The style object which will be applied.
* @param {StyleFlag} flag - Flags which indicates applied formatting properties.
*/
applyColumnStyle(column, style, flag) {
}
/**
* Applies formats for a whole row.
* @param {Number} row - The row index.
* @param {Style} style - The style object which will be applied.
* @param {StyleFlag} flag - Flags which indicates applied formatting properties.
*/
applyRowStyle(row, style, flag) {
}
/**
* Applies formats for a whole worksheet.
* @param {Style} style - The style object which will be applied.
* @param {StyleFlag} flag - Flags which indicates applied formatting properties.
*/
applyStyle(style, flag) {
}
/**
* Copies data and formats of a whole column.
* @param {Cells} sourceCells0 - Source Cells object contains data and formats to copy.
* @param {Number} sourceColumnIndex - Source column index.
* @param {Number} destinationColumnIndex - Destination column index.
* @param {Number} columnNumber - The copied column number.
* @param {PasteOptions} pasteOptions - the options of pasting.
*/
copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions) {
}
/**
* Copies data and formats of a whole column.
* @param {Cells} sourceCells - Source Cells object contains data and formats to copy.
* @param {Number} sourceColumnIndex - Source column index.
* @param {Number} destinationColumnIndex - Destination column index.
*/
copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex) {
}
/**
* Copies data and formats of a whole column.
* @param {Cells} sourceCells0 - Source Cells object contains data and formats to copy.
* @param {Number} sourceColumnIndex - Source column index.
* @param {Number} destinationColumnIndex - Destination column index.
* @param {Number} columnNumber - The copied column number.
*/
copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber) {
}
/**
* Copies data and formats of the whole columns.
* @param {Cells} sourceCells - Source Cells object contains data and formats to copy.
* @param {Number} sourceColumnIndex - Source column index.
* @param {Number} sourceTotalColumns - The number of the source columns.
* @param {Number} destinationColumnIndex - Destination column index.
* @param {Number} destinationTotalColumns - The number of the destination columns.
*/
copyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns) {
}
/**
* Copies data and formats of a whole row.
* @param {Cells} sourceCells - Source Cells object contains data and formats to copy.
* @param {Number} sourceRowIndex - Source row index.
* @param {Number} destinationRowIndex - Destination row index.
*/
copyRow(sourceCells, sourceRowIndex, destinationRowIndex) {
}
/**
* Copies data and formats of some whole rows.
* @param {Cells} sourceCells - Source Cells object contains data and formats to copy.
* @param {Number} sourceRowIndex - Source row index.
* @param {Number} destinationRowIndex - Destination row index.
* @param {Number} rowNumber - The copied row number.
*/
copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber) {
}
/**
* Copies data and formats of some whole rows.
* @param {Cells} sourceCells0 - Source Cells object contains data and formats to copy.
* @param {Number} sourceRowIndex - Source row index.
* @param {Number} destinationRowIndex - Destination row index.
* @param {Number} rowNumber - The copied row number.
* @param {CopyOptions} copyOptions - The copy options.
*/
copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions) {
}
/**
* Copies data and formats of some whole rows.
* @param {Cells} sourceCells0 - Source Cells object contains data and formats to copy.
* @param {Number} sourceRowIndex - Source row index.
* @param {Number} destinationRowIndex - Destination row index.
* @param {Number} rowNumber - The copied row number.
* @param {CopyOptions} copyOptions - The copy options.
* @param {PasteOptions} pasteOptions - the options of pasting.
*/
copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions) {
}
/**
* Gets the outline level (zero-based) of the row.
* If the row is not grouped, returns zero.
* @param {Number} rowIndex - The row index.
* @return {Number} The outline level (zero-based) of the row.
*/
getGroupedRowOutlineLevel(rowIndex) {
}
/**
* Gets the outline level (zero-based) of the column.
* If the column is not grouped, returns zero.
* @param {Number} columnIndex - The column index
* @return {Number} The outline level of the column
*/
getGroupedColumnOutlineLevel(columnIndex) {
}
/**
* Gets the max grouped column outline level (zero-based).
* @return {Number} The max grouped column outline level (zero-based)
*/
getMaxGroupedColumnOutlineLevel() {
}
/**
* Gets the max grouped row outline level (zero-based).
* @return {Number} The max grouped row outline level (zero-based)
*/
getMaxGroupedRowOutlineLevel() {
}
/**
* Expands the grouped rows/columns.
* @param {boolean} isVertical - True, expands the grouped rows.
* @param {Number} index - The row/column index
*/
showGroupDetail(isVertical, index) {
}
/**
* Collapses the grouped rows/columns.
* @param {boolean} isVertical - True, collapse the grouped rows.
* @param {Number} index - The row/column index
*/
hideGroupDetail(isVertical, index) {
}
/**
* Ungroups columns.
* @param {Number} firstIndex - The first column index to be ungrouped.
* @param {Number} lastIndex - The last column index to be ungrouped.
*/
ungroupColumns(firstIndex, lastIndex) {
}
/**
* Groups columns.
* @param {Number} firstIndex - The first column index to be grouped.
* @param {Number} lastIndex - The last column index to be grouped.
*/
groupColumns(firstIndex, lastIndex) {
}
/**
* Groups columns.
* @param {Number} firstIndex - The first column index to be grouped.
* @param {Number} lastIndex - The last column index to be grouped.
* @param {boolean} isHidden - Specifies if the grouped columns are hidden.
*/
groupColumns(firstIndex, lastIndex, isHidden) {
}
/**
* Ungroups rows.
* @param {Number} firstIndex - The first row index to be ungrouped.
* @param {Number} lastIndex - The last row index to be ungrouped.
* @param {boolean} isAll - True, removes all grouped info.Otherwise, remove the outer group info.
*/
ungroupRows(firstIndex, lastIndex, isAll) {
}
/**
* Ungroups rows.
* Only removes outer group info.
* @param {Number} firstIndex - The first row index to be ungrouped.
* @param {Number} lastIndex - The last row index to be ungrouped.
*/
ungroupRows(firstIndex, lastIndex) {
}
/**
* Groups rows.
* @param {Number} firstIndex - The first row index to be grouped.
* @param {Number} lastIndex - The last row index to be grouped.
* @param {boolean} isHidden - Specifies if the grouped rows are hidden.
*/
groupRows(firstIndex, lastIndex, isHidden) {
}
/**
* Groups rows.
* @param {Number} firstIndex - The first row index to be grouped.
* @param {Number} lastIndex - The last row index to be grouped.
*/
groupRows(firstIndex, lastIndex) {
}
/**
* Deletes a column.
* @param {Number} columnIndex - Index of the column to be deleted.
* @param {boolean} updateReference - Indicates whether update references in other worksheets.
*/
deleteColumn(columnIndex, updateReference) {
}
/**
* Deletes a column.
* @param {Number} columnIndex - Index of the column to be deleted.
*/
deleteColumn(columnIndex) {
}
/**
* Deletes several columns.
* @param {Number} columnIndex - Index of the first column to be deleted.
* @param {Number} totalColumns - Count of columns to be deleted.
* @param {boolean} updateReference - Indicates whether update references in other worksheets.
*/
deleteColumns(columnIndex, totalColumns, updateReference) {
}
/**
* Check whether the range could be deleted.
* @param {Number} startRow - The start row index of the range.
* @param {Number} startColumn - The start column index of the range.
* @param {Number} totalRows - The number of the rows in the range.
* @param {Number} totalColumns - The number of the columns in the range.
* @return {boolean}
*/
isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns) {
}
/**
* Deletes a row.
* @param {Number} rowIndex - Index of the row to be deleted.
*/
deleteRow(rowIndex) {
}
/**
* Deletes several rows.
* 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.
* @param {Number} rowIndex - The first row index to be deleted.
* @param {Number} totalRows - Count of rows to be deleted.
*/
deleteRows(rowIndex, totalRows) {
}
/**
* Deletes a row.
* @param {Number} rowIndex - Index of the row to be deleted.
* @param {boolean} updateReference - Indicates whether update references in other worksheets.
*/
deleteRow(rowIndex, updateReference) {
}
/**
* Deletes multiple rows in the worksheet.
* @param {Number} rowIndex - Index of the first row to be deleted.
* @param {Number} totalRows - Count of rows to be deleted.
* @param {boolean} updateReference - Indicates whether update references in other worksheets.
* @return {boolean}
*/
deleteRows(rowIndex, totalRows, updateReference) {
}
/**
* Delete all blank columns which do not contain any data.
*/
deleteBlankColumns() {
}
/**
* Delete all blank columns which do not contain any data.
* @param {DeleteOptions} options - The options of deleting range.
*/
deleteBlankColumns(options) {
}
/**
* Checks whether given column is blank(does not contain any data).
* @param {Number} columnIndex - the column index
* @return {boolean} true if given column does not contain any data
*/
isBlankColumn(columnIndex) {
}
/**
* Delete all blank rows which do not contain any data or other object.
*/
deleteBlankRows() {
}
/**
* Delete all blank rows which do not contain any data or other object.
* For blank rows that will be deleted, it is not only required that Row.IsBlank 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.
* @param {DeleteOptions} options - The options of deleting range.
*/
deleteBlankRows(options) {
}
/**
* Inserts some columns into the worksheet.
* @param {Number} columnIndex - Column index.
* @param {Number} totalColumns - The number of columns.
*/
insertColumns(columnIndex, totalColumns) {
}
/**
* Inserts some columns into the worksheet.
* @param {Number} columnIndex - Column index.
* @param {Number} totalColumns - The number of columns.
* @param {boolean} updateReference - Indicates if references in other worksheets will be updated.
*/
insertColumns(columnIndex, totalColumns, updateReference) {
}
/**
* Inserts a new column into the worksheet.
* @param {Number} columnIndex - Column index.
* @param {boolean} updateReference - Indicates if references in other worksheets will be updated.
*/
insertColumn(columnIndex, updateReference) {
}
/**
* Inserts a new column into the worksheet.
* @param {Number} columnIndex - Column index.
*/
insertColumn(columnIndex) {
}
/**
* Inserts multiple rows into the worksheet.
* @param {Number} rowIndex - Row index.
* @param {Number} totalRows - Number of rows to be inserted.
* @param {boolean} updateReference - Indicates if references in other worksheets will be updated.
*/
insertRows(rowIndex, totalRows, updateReference) {
}
/**
* Inserts multiple rows into the worksheet.
* @param {Number} rowIndex - Row index.
* @param {Number} totalRows - Number of rows to be inserted.
* @param {InsertOptions} options - Indicates if references in other worksheets will be updated.
*/
insertRows(rowIndex, totalRows, options) {
}
/**
* Inserts multiple rows into the worksheet.
* @param {Number} rowIndex - Row index.
* @param {Number} totalRows - Number of rows to be inserted.
*/
insertRows(rowIndex, totalRows) {
}
/**
* Inserts a new row into the worksheet.
* @param {Number} rowIndex - Row index.
*/
insertRow(rowIndex) {
}
/**
* Clears contents and formatting of a range.
* @param {CellArea} range - Range to be cleared.
*/
clearRange(range) {
}
/**
* Clears contents and formatting of a range.
* @param {Number} startRow - Start row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endRow - End row index.
* @param {Number} endColumn - End column index.
*/
clearRange(startRow, startColumn, endRow, endColumn) {
}
/**
* Clears contents of a range.
* @param {CellArea} range - Range to be cleared.
*/
clearContents(range) {
}
/**
* Clears contents of a range.
* @param {Number} startRow - Start row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endRow - End row index.
* @param {Number} endColumn - End column index.
*/
clearContents(startRow, startColumn, endRow, endColumn) {
}
/**
* Clears formatting of a range.
* @param {CellArea} range - Range to be cleared.
*/
clearFormats(range) {
}
/**
* Clears formatting of a range.
* @param {Number} startRow - Start row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endRow - End row index.
* @param {Number} endColumn - End column index.
*/
clearFormats(startRow, startColumn, endRow, endColumn) {
}
/**
* Link to a xml map.
* e.g. A xml map element structure:
* -RootElement
* |-Attribute1
* |-SubElement
* |-Attribute2
* |-Attribute3
* To link "Attribute1", path is "/RootElement/Attribute1"
* To link "Attribute2", path is "/RootElement/SubElement/Attribute2"
* To link whole "SubElement", path is "/RootElement/SubElement"
* @param {String} mapName - name of xml map
* @param {Number} row - row of the destination cell
* @param {Number} column - column of the destination cell
* @param {String} path - path of xml element in xml map
*/
linkToXmlMap(mapName, row, column, path) {
}
/**
* Finds the cell containing with the input object.
* Returns null (Nothing) if no cell is found.
* @param {Object} what - The object to search for.
* The type should be int,double,DateTime,string,bool.
* @param {Cell} previousCell - Previous cell with the same object.
* This parameter can be set to null if searching from the start.
* @return {Cell} Cell object.
*/
find(what, previousCell) {
}
/**
* Finds the cell containing with the input object.
* Returns null (Nothing) if no cell is found.
* @param {Object} what - The object to search for.
* The type should be int,double,DateTime,string,bool.
* @param {Cell} previousCell - Previous cell with the same object.
* This parameter can be set to null if searching from the start.
* @param {FindOptions} findOptions - Find options
* @return {Cell} Cell object.
*/
find(what, previousCell, findOptions) {
}
/**
* Gets the last cell in this row.
* @param {Number} rowIndex - Row index.
* @return {Cell} Cell object.
*/
endCellInRow(rowIndex) {
}
/**
* Gets the last cell in this column.
* @param {Number} columnIndex - Column index.
* @return {Cell} Cell object.
*/
endCellInColumn(columnIndex) {
}
/**
* Gets the last cell with maximum column index in this range.
* @param {Number} startRow - Start row index.
* @param {Number} endRow - End row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endColumn - End column index.
* @return {Cell} Cell object.
*/
endCellInColumn(startRow, endRow, startColumn, endColumn) {
}
/**
* Gets the last cell with maximum row index in this range.
* @param {Number} startRow - Start row index.
* @param {Number} endRow - End row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endColumn - End column index.
* @return {Cell} Cell object.
*/
endCellInRow(startRow, endRow, startColumn, endColumn) {
}
/**
* Moves the range.
* @param {CellArea} sourceArea - The range which should be moved.
* @param {Number} destRow - The dest row.
* @param {Number} destColumn - The dest column.
*/
moveRange(sourceArea, destRow, destColumn) {
}
/**
* Insert cut range.
* @param {Range} cutRange - The cut range.
* @param {Number} row - The row.
* @param {Number} column - The column.
* @param {Number} shiftType - ShiftType
*/
insertCutCells(cutRange, row, column, shiftType) {
}
/**
* Inserts a range of cells and shift cells according to the shift option.
* @param {CellArea} area - Shift area.
* @param {Number} shiftNumber - Number of rows or columns to be inserted.
* @param {Number} shiftType - ShiftType
* @param {boolean} updateReference - Indicates whether update references in other worksheets.
*/
insertRange(area, shiftNumber, shiftType, updateReference) {
}
/**
* Inserts a range of cells and shift cells according to the shift option.
* @param {CellArea} area - Shift area.
* @param {Number} shiftType - ShiftType
*/
insertRange(area, shiftType) {
}
/**
* Inserts a range of cells and shift cells according to the shift option.
* @param {CellArea} area - Shift area.
* @param {Number} shiftNumber - Number of rows or columns to be inserted.
* @param {Number} shiftType - ShiftType
*/
insertRange(area, shiftNumber, shiftType) {
}
/**
* Deletes a range of cells and shift cells according to the shift option.
* @param {Number} startRow - Start row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endRow - End row index.
* @param {Number} endColumn - End column index.
* @param {Number} shiftType - ShiftType
*/
deleteRange(startRow, startColumn, endRow, endColumn, shiftType) {
}
/**
* Performs application-defined tasks associated with freeing, releasing, or
* resetting unmanaged resources.
*/
dispose() {
}
/**
* Gets the cells enumerator.
* 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).@return {Iterator} The cells enumerator
*/
iterator() {
}
/**
* Gets the rows enumerator.
* NOTE: This member is now obsolete. Instead,
* please use RowCollection.GetEnumerator() method.
* This method will be removed 12 months later since May 2023.
* Aspose apologizes for any inconvenience you may have experienced.@return {Iterator} The rows enumerator.See Also:RowCollection.iterator()
*/
getRowEnumerator() {
}
/**
* Gets all merged cells.
*/
getMergedAreas() {
}
/**
* Gets the Cell element or null at the specified cell row index and column index.
* @param {Number} row - Row index
* @param {Number} column - Column index
* @return {Cell} Return Cell object if a Cell object exists.
* Return null if the cell does not exist.
*/
checkCell(row, column) {
}
/**
* Gets the Row element or null at the specified cell row index.
* @param {Number} row - Row index
* @return {Row}
* Returns Row object If the row object does exist, otherwise returns null.
*/
checkRow(row) {
}
/**
* Gets the Column element or null at the specified column index.
* @param {Number} columnIndex - The column index.
* @return {Column} The Column object.
*/
checkColumn(columnIndex) {
}
/**
* Checks whether a row at given index is hidden.
* @param {Number} rowIndex - row index
* @return {boolean} true if the row is hidden
*/
isRowHidden(rowIndex) {
}
/**
* Checks whether a column at given index is hidden.
* @param {Number} columnIndex - column index
* @return {boolean} true if the column is hidden.
*/
isColumnHidden(columnIndex) {
}
/**
* Adds a range object reference to cells
* @param {Range} rangeObject - The range object will be contained in the cells
*/
addRange(rangeObject) {
}
/**
* Creates a Range object from a range of cells.
* @param {String} upperLeftCell - Upper left cell name.
* @param {String} lowerRightCell - Lower right cell name.
* @return {Range} A Range object
*/
createRange(upperLeftCell, lowerRightCell) {
}
/**
* Creates a Range object from a range of cells.
* @param {Number} firstRow - First row of this range
* @param {Number} firstColumn - First column of this range
* @param {Number} totalRows - Number of rows
* @param {Number} totalColumns - Number of columns
* @return {Range} A Range object
*/
createRange(firstRow, firstColumn, totalRows, totalColumns) {
}
/**
* Creates a Range object from an address of the range.
* @param {String} address - The address of the range.
* @return {Range} A Range object
*/
createRange(address) {
}
/**
* Creates a Range object from rows of cells or columns of cells.
* @param {Number} firstIndex - First row index or first column index, zero based.
* @param {Number} number - Total number of rows or columns, one based.
* @param {boolean} isVertical - True - Range created from columns of cells. False - Range created from rows of cells.
* @return {Range} A Range object.
*/
createRange(firstIndex, number, isVertical) {
}
/**
* Clears all data of the worksheet.
*/
clear() {
}
/**
* Imports an array of formula into a worksheet.
* @param {String[]} stringArray - Formula array.
* @param {Number} firstRow - The row number of the first cell to import in.
* @param {Number} firstColumn - The column number of the first cell to import in.
* @param {boolean} isVertical - Specifies to import data vertically or horizontally.
*/
importFormulaArray(stringArray, firstRow, firstColumn, isVertical) {
}
/**
* Splits the text in the column to columns.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @param {Number} totalRows - The number of rows.
* @param {TxtLoadOptions} options - The split options.
*/
textToColumns(row, column, totalRows, options) {
}
/**
* Import a CSV file to the cells.
* @param {String} fileName - The CSV file name.
* @param {String} splitter - The splitter
* @param {boolean} convertNumericData - Whether the string in text file is converted to numeric data.
* @param {Number} firstRow - The row number of the first cell to import in.
* @param {Number} firstColumn - The column number of the first cell to import in.
*/
importCSV(fileName, splitter, convertNumericData, firstRow, firstColumn) {
}
/**
* Import a CSV file to the cells.
* @param {String} fileName - The CSV file name.
* @param {TxtLoadOptions} options - The load options for reading text file
* @param {Number} firstRow - The row number of the first cell to import in.
* @param {Number} firstColumn - The column number of the first cell to import in.
*/
importCSV(fileName, options, firstRow, firstColumn) {
}
/**
* Merges a specified range of cells into a single cell.
* Reference the merged cell via the address of the upper-left cell in the range.
* @param {Number} firstRow - First row of this range(zero based)
* @param {Number} firstColumn - First column of this range(zero based)
* @param {Number} totalRows - Number of rows(one based)
* @param {Number} totalColumns - Number of columns(one based)
*/
merge(firstRow, firstColumn, totalRows, totalColumns) {
}
/**
* Merges a specified range of cells into a single cell.
* 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.
* @param {Number} firstRow - First row of this range(zero based)
* @param {Number} firstColumn - First column of this range(zero based)
* @param {Number} totalRows - Number of rows(one based)
* @param {Number} totalColumns - Number of columns(one based)
* @param {boolean} mergeConflict - Merge conflict merged ranges.
*/
merge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict) {
}
/**
* Merges a specified range of cells into a single cell.
* 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.
* @param {Number} firstRow - First row of this range(zero based)
* @param {Number} firstColumn - First column of this range(zero based)
* @param {Number} totalRows - Number of rows(one based)
* @param {Number} totalColumns - Number of columns(one based)
* @param {boolean} checkConflict - Indicates whether check the merged cells intersects other merged cells
* @param {boolean} mergeConflict - Merge conflict merged ranges.
*/
merge(firstRow, firstColumn, totalRows, totalColumns, checkConflict, mergeConflict) {
}
/**
* Unmerges a specified range of merged cells.
* @param {Number} firstRow - First row of this range(zero based)
* @param {Number} firstColumn - First column of this range(zero based)
* @param {Number} totalRows - Number of rows(one based)
* @param {Number} totalColumns - Number of columns(one based)
*/
unMerge(firstRow, firstColumn, totalRows, totalColumns) {
}
/**
* Clears all merged ranges.
*/
clearMergedCells() {
}
/**
* Hides a row.
* @param {Number} row - Row index.
*/
hideRow(row) {
}
/**
* Unhides a row.
* @param {Number} row - Row index.
* @param {Number} height - Row height. The row's height will be changed only when the row is hidden and given height value is positive.
*/
unhideRow(row, height) {
}
/**
* Hides multiple rows.
* @param {Number} row - The row index.
* @param {Number} totalRows - The row number.
*/
hideRows(row, totalRows) {
}
/**
* Unhides the hidden rows.
* @param {Number} row - The row index.
* @param {Number} totalRows - The row number.
* @param {Number} height - Row height. The row's height will be changed only when the row is hidden and given height value is positive.
*/
unhideRows(row, totalRows, height) {
}
/**
* Sets row height in unit of pixels.
* @param {Number} row - Row index.
* @param {Number} pixels - Number of pixels.
*/
setRowHeightPixel(row, pixels) {
}
/**
* Sets row height in unit of inches.
* @param {Number} row - Row index.
* @param {Number} inches - Number of inches. It should be between 0 and 409.5/72.
*/
setRowHeightInch(row, inches) {
}
/**
* Sets the height of the specified row.
* @param {Number} row - Row index.
* @param {Number} height - Height of row.In unit of point It should be between 0 and 409.5.
*/
setRowHeight(row, height) {
}
/**
* Gets original row's height in unit of point if the row is hidden
* @param {Number} row - The row index.
* @return {Number}
*/
getRowOriginalHeightPoint(row) {
}
/**
* Gets original column's height in unit of point if the column is hidden
* @param {Number} column - The row index.
* @return {Number}
*/
getColumnOriginalWidthPoint(column) {
}
/**
* Hides a column.
* @param {Number} column - Column index.
*/
hideColumn(column) {
}
/**
* Unhides a column
* @param {Number} column - Column index.
* @param {Number} width - Column width.
*/
unhideColumn(column, width) {
}
/**
* Hide multiple columns.
* @param {Number} column - Column index.
* @param {Number} totalColumns - Column number.
*/
hideColumns(column, totalColumns) {
}
/**
* Unhide multiple columns.
* Only applies the column width to the hidden columns.
* @param {Number} column - Column index.
* @param {Number} totalColumns - Column number
* @param {Number} width - Column width.
*/
unhideColumns(column, totalColumns, width) {
}
/**
* Gets the height of a specified row, in unit of points.
* @param {Number} row - Row index
* @return {Number} Height of row
*/
getRowHeight(row) {
}
/**
* Gets the height of a specified row.
* @param {Number} row - Row index.
* @return {Number} Height of row.
*/
getViewRowHeight(row) {
}
/**
* Gets the height of a specified row in unit of pixel.
* @param {Number} row - Row index
* @return {Number} Height of row
*/
getRowHeightPixel(row) {
}
/**
* Gets the height of a specified row in unit of inches.
* @param {Number} row - Row index
* @return {Number} Height of row
*/
getRowHeightInch(row) {
}
/**
* Gets the height of a specified row in unit of inches.
* @param {Number} row - Row index
* @return {Number} Height of row
*/
getViewRowHeightInch(row) {
}
/**
* Sets column width in unit of pixels in normal view.
* @param {Number} column - Column index.
* @param {Number} pixels - Number of pixels.
*/
setColumnWidthPixel(column, pixels) {
}
/**
* Sets column width in unit of inches in normal view.
* @param {Number} column - Column index.
* @param {Number} inches - Number of inches.
*/
setColumnWidthInch(column, inches) {
}
/**
* Sets the width of the specified column in normal view.
* To hide a column, sets column width to zero.
* @param {Number} column - Column index.
* @param {Number} width - Width of column.Column width must be between 0 and 255.
*/
setColumnWidth(column, width) {
}
/**
* Gets the width of the specified column in normal view, in units of pixel.
* @param {Number} column - Column index
* @return {Number} Width of column in normal view.
*/
getColumnWidthPixel(column) {
}
/**
* Gets the width of the specified column in normal view, in units of pixel.
* @param {Number} column - Column index
* @param {boolean} original - Indicates whether returning original width even when the column is hidden
* @return {Number} Width of column in normal view.
*/
getColumnWidthPixel(column, original) {
}
/**
* Gets the width of the specified column in normal view, in units of inches.
* @param {Number} column - Column index
* @return {Number} Width of column
*/
getColumnWidthInch(column) {
}
/**
* Gets the width(in unit of characters) of the specified column in normal view
* @param {Number} column - Column index
* @return {Number}
* 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) {
}
/**
* Get the width in different view type.
* @param {Number} column - The column index.
* @return {Number} the column width in unit of pixels
*/
getViewColumnWidthPixel(column) {
}
/**
* Sets the width of the column in different view.
* If the current view type is ViewType.PAGE_LAYOUT_VIEW, the column's width is same as printed width.
* @param {Number} column - The column index.
* @param {Number} pixels - The width in unit of pixels.
*/
setViewColumnWidthPixel(column, pixels) {
}
/**
* Import a CSV file to the cells.
* @param {Cells} cells - The Cells object
* @param {ReadableStream} stream - The CSV file stream
* @param {String} spliter - The spliter
* @param {boolean} convertNumericData - Whether the string in text file is converted to numeric data
* @param {Number} firstRow - The row number of the first cell to import in
* @param {Number} firstColumn - The column number of the first cell to import in
* @param {Callback} callback - The callback function
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* var readStream = fs.createReadStream("EmployeeList.csv");
* aspose.cells.Cells.importCSVFromStream(cells, readStream, ",", false, 0, 1,
* function(err) {
* workbook.save('result.xlsx');
* }
* );
*/
static importCSVFromStream(cells, stream, spliter, convertNumericData, firstRow, firstColumn, callback) {
}
/**
* Import a CSV file to the cells.
* @param {Cells} cells - The Cells object
* @param {ReadableStream} stream - The CSV file stream
* @param {TxtLoadOptions} options - The load options for reading text file
* @param {Number} firstRow - The row number of the first cell to import in
* @param {Number} firstColumn - The column number of the first cell to import in
* @param {Callback} callback - The callback function
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* var loadOptions = new aspose.cells.TxtLoadOptions();
* var readStream = fs.createReadStream("EmployeeList.csv");
* aspose.cells.Cells.importCSVFromStream(cells, readStream, loadOptions, 0, 1,
* function(err) {
* workbook.save('result.xlsx');
* }
* );
*/
static importCSVFromStream(cells, stream, options, firstRow, firstColumn, callback) {
}
}
/**
* Represents all types of color.
* @hideconstructor
*/
class CellsColor {
/**
* Gets and set the color which should apply to cell or shape.
* 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() {
}
/**
* Gets and set the color which should apply to cell or shape.
* 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.
*/
setShapeColor(value) {
}
/**
* The color type.
* The value of the property is ColorType integer constant.
*/
getType() {
}
/**
* Gets the theme color. Only applies for theme color type.
*/
getThemeColor() {
}
/**
* Gets the theme color. Only applies for theme color type.
*/
setThemeColor(value) {
}
/**
* Gets and sets the color index in the color palette. Only applies of indexed color.
*/
getColorIndex() {
}
/**
* Gets and sets the color index in the color palette. Only applies of indexed color.
*/
setColorIndex(value) {
}
/**
* Gets and sets the RGB color.
*/
getColor() {
}
/**
* Gets and sets the RGB color.
*/
setColor(value) {
}
/**
* Gets and sets the color from a 32-bit ARGB value.
*/
getArgb() {
}
/**
* Gets and sets the color from a 32-bit ARGB value.
*/
setArgb(value) {
}
/**
* Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Set the tint of the shape color
* @param {Number} tint
*/
setTintOfShapeColor(tint) {
}
}
/**
* Utility to build ICellsDataTable from custom objects for user's convenience.
* @hideconstructor
*/
class CellsDataTableFactory {
/**
* Creates ICellsDataTable from given sequence of int values.
* @param {Number[]} vals - int values to build table
* @param {String[]} columnNames - Column names of the table.
* Its length can only be either 1(build table by the int values vertically)
* or length of the int values(build table by the int values horizontally)
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals, columnNames) {
}
/**
* Creates ICellsDataTable from given sequence of int values.
* @param {Number[]} vals - int values to build table
* @param {boolean} vertial - whether build table by the int values vertiacally(true) or horizontally(false)
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals, vertial) {
}
/**
* Creates ICellsDataTable from given sequence of double values.
* @param {Number[]} vals - double values to build table
* @param {String[]} columnNames - Column names of the table.
* Its length can only be either 1(build table by the double values vertically)
* or length of the double values(build table by the double values horizontally)
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals, columnNames) {
}
/**
* Creates ICellsDataTable from given sequence of double values.
* @param {Number[]} vals - double values to build table
* @param {boolean} vertial - whether build table by the double values vertiacally(true) or horizontally(false)
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals, vertial) {
}
/**
* Creates ICellsDataTable from given sequence of objects.
* @param {Object[]} vals - objects to build table
* @param {String[]} columnNames - Column names of the table.
* Its length can only be either 1(build table by the objects vertically)
* or length of the objects(build table by the objects horizontally)
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals, columnNames) {
}
/**
* Creates ICellsDataTable from given sequence of objects.
* @param {Object[]} vals - objects to build table
* @param {boolean} vertial - whether build table by the objects vertiacally(true) or horizontally(false)
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals, vertial) {
}
/**
* Creates ICellsDataTable from given 2D array.
* @param {int[][]} vals - int values to build table
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals) {
}
/**
* Creates ICellsDataTable from given 2D array.
* @param {double[][]} vals - double values to build table
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals) {
}
/**
* Creates ICellsDataTable from given 2D array.
* @param {Object[][]} vals - objects to build table
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(vals) {
}
/**
* Creates ICellsDataTable from given collection.
* @param {Collection} collection - the collection to build table
* @return {ICellsDataTable} Instance of ICellsDataTable
*/
getInstance(collection) {
}
}
/**
* Represents the auto shape and drawing object.
* @hideconstructor
*/
class CellsDrawing {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* The exception that is thrown when Aspose.Cells specified error occurs.
* @hideconstructor
*/
class CellsException {
/**
* Represents custom exception code.
* The value of the property is ExceptionType integer constant.
*/
getCode() {
}
}
/**
* Utility for instantiating classes of Cells model.
*/
class CellsFactory {
/**
*/
constructor() {
}
/**
* Creates a new style.
* @return {Style} Returns a style object.
*/
createStyle() {
}
}
/**
* Provides helper functions.
* @hideconstructor
*/
class CellsHelper {
/**
* Gets and sets the number of significant digits.
* The default value is 17.
* Only could be 15 or 17 now.
*/
getSignificantDigits() {
}
/**
* Gets and sets the number of significant digits.
* The default value is 17.
* Only could be 15 or 17 now.
*/
setSignificantDigits(value) {
}
/**
* Gets the DPI of the machine.
*/
getDPI() {
}
/**
* Gets the DPI of the machine.
*/
setDPI(value) {
}
/**
* Gets or sets the startup path, which is referred to by some external formula references.
*/
getStartupPath() {
}
/**
* Gets or sets the startup path, which is referred to by some external formula references.
*/
setStartupPath(value) {
}
/**
* Gets or sets the alternate startup path, which is referred to by some external formula references.
*/
getAltStartPath() {
}
/**
* Gets or sets the alternate startup path, which is referred to by some external formula references.
*/
setAltStartPath(value) {
}
/**
* Gets or sets the library path which is referred to by some external formula references.
*/
getLibraryPath() {
}
/**
* Gets or sets the library path which is referred to by some external formula references.
*/
setLibraryPath(value) {
}
/**
* Gets or sets the factory for creating instances with special implementation.
*/
getCustomImplementationFactory() {
}
/**
* Gets or sets the factory for creating instances with special implementation.
*/
setCustomImplementationFactory(value) {
}
/**
* Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,
*/
isCloudPlatform() {
}
/**
* Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,
*/
setCloudPlatform(value) {
}
/**
* Get width of text in unit of points.
* @param {String} text - The text.
* @param {Font} font - The font of the text.
* @param {Number} scaling - The scaling of text.
* @return {Number}
*/
static getTextWidth(text, font, scaling) {
}
/**
* Get the release version.
* @return {String} The release version.
*/
static getVersion() {
}
/**
* Gets the cell row and column indexes according to its name.
* @param {String} cellName - Name of cell
* @return {Number[]} [0] is the row index and [1] is the column index.
*/
static cellNameToIndex(cellName) {
}
/**
* Gets cell name according to its row and column indexes.
* @param {Number} row - Row index.
* @param {Number} column - Column index.
* @return {String} Name of cell.
*/
static cellIndexToName(row, column) {
}
/**
* Gets column name according to column index.
* @param {Number} column - Column index.
* @return {String} Name of column.
*/
static columnIndexToName(column) {
}
/**
* Gets column index according to column name.
* @param {String} columnName - Column name.
* @return {Number} Column index.
*/
static columnNameToIndex(columnName) {
}
/**
* Gets row name according to row index.
* @param {Number} row - Row index.
* @return {String} Name of row.
*/
static rowIndexToName(row) {
}
/**
* Gets row index according to row name.
* @param {String} rowName - Row name.
* @return {Number} Row index.
*/
static rowNameToIndex(rowName) {
}
/**
* Converts the r1c1 formula of the cell to A1 formula.
* NOTE: This member is now obsolete. Instead, please use Worksheet.ConvertFormulaReferenceStyle() method.
* This property will be removed 12 months later since August 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} r1c1Formula - The r1c1 formula.
* @param {Number} row - The row index of the cell.
* @param {Number} column - The column index of the cell.
* @return {String} The A1 formula.
*/
static convertR1C1FormulaToA1(r1c1Formula, row, column) {
}
/**
* Converts A1 formula of the cell to the r1c1 formula.
* NOTE: This member is now obsolete. Instead, please use Worksheet.ConvertFormulaReferenceStyle() method.
* This property will be removed 12 months later since August 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} formula - The A1 formula.
* @param {Number} row - The row index of the cell.
* @param {Number} column - The column index of the cell.
* @return {String} The R1C1 formula.
*/
static convertA1FormulaToR1C1(formula, row, column) {
}
/**
* Convert the double value to the date time value.
* @param {Number} doubleValue - The double value.
* @param {boolean} date1904 - Date 1904 system.
* @return {DateTime}
*/
static getDateTimeFromDouble(doubleValue, date1904) {
}
/**
* Convert the date time to double value.
* @param {DateTime} dateTime - The date time.
* @param {boolean} date1904 - Date 1904 system.
* @return {Number}
*/
static getDoubleFromDateTime(dateTime, date1904) {
}
/**
* Gets all used colors in the workbook.
* @param {Workbook} workbook - The workbook object.
* @return {Color[]} The used colors.
*/
static getUsedColors(workbook) {
}
/**
* Add addin function.
* NOTE: This member is now obsolete. Instead,
* please use WorksheetCollection.RegisterAddInFunction() methods.
* This method will be removed 12 months later since January 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} function - The function name.
* @param {Number} minCountOfParameters - Minimum number of parameters this function requires
* @param {Number} maxCountOfParameters - Maximum number of parameters this function allows.
* @param {Number[]} paramersType - The excepted parameters type of the function
* @param {Number} functionValueType - ParameterType
*/
static addAddInFunction(function_, minCountOfParameters, maxCountOfParameters, paramersType, functionValueType) {
}
/**
* Merges some large xls files to a xls file.
* This method only supports merging data, style and formulas to the new file.
* The cached file is used to store some temporary data.
* @param {String[]} files - The files.
* @param {String} cachedFile - The cached file.
* @param {String} destFile - The dest file.
*/
static mergeFiles(files, cachedFile, destFile) {
}
/**
* Checks given sheet name and create a valid one when needed.
* If given sheet name conforms to the rules of excel sheet name, then return it.
* Otherwise string will be truncated if length exceeds the limit
* and invalid characters will be replaced with ' ', then return the rebuilt string value.
* @param {String} nameProposal - sheet name to be used
* @return {String}
*/
static createSafeSheetName(nameProposal) {
}
/**
* Checks given sheet name and create a valid one when needed.
* If given sheet name conforms to the rules of excel sheet name, then return it.
* Otherwise string will be truncated if length exceeds the limit
* and invalid characters will be replaced with given character, then return the rebuilt string value.
* @param {String} nameProposal - sheet name to be used
* @param {char} replaceChar - character which will be used to replace invalid characters in given sheet name
* @return {String}
*/
static createSafeSheetName(nameProposal, replaceChar) {
}
/**
* Indicates whether the name of the sheet should be enclosed in single quotes
* @param {String} sheetName - The name of the sheet
* @return {boolean}
*/
static needQuoteInFormula(sheetName) {
}
}
/**
* Represents the cell value and corresponding type.
*/
class CellValue {
/**
*/
constructor() {
}
/**
* Gets/sets the type of cell value.
* The value of the property is CellValueType integer constant.
*/
getType() {
}
/**
* Gets/sets the type of cell value.
* The value of the property is CellValueType integer constant.
*/
setType(value) {
}
/**
* Gets/sets the cell value.
* The value must be of the correct type of object corresponding to the Type:
* TypeValueCellValueType.IS_NULLnull, any other object will be ignoredCellValueType.IS_NUMERICdoubleCellValueType.IS_DATE_TIMEDateTimeCellValueType.IS_STRINGstringCellValueType.IS_BOOLboolCellValueType.IS_ERRORerror string such as "#VALUE!", "#NAME?", ...
*/
getValue() {
}
/**
* Gets/sets the cell value.
* The value must be of the correct type of object corresponding to the Type:
* TypeValueCellValueType.IS_NULLnull, any other object will be ignoredCellValueType.IS_NUMERICdoubleCellValueType.IS_DATE_TIMEDateTimeCellValueType.IS_STRINGstringCellValueType.IS_BOOLboolCellValueType.IS_ERRORerror string such as "#VALUE!", "#NAME?", ...
*/
setValue(value) {
}
}
/**
* Represents Cell Watch Item in the 'watch window'.
*/
class CellWatch {
/**
*/
constructor() {
}
/**
* Gets and sets the row of the cell.
*/
getRow() {
}
/**
* Gets and sets the row of the cell.
*/
setRow(value) {
}
/**
* Gets and sets the column of the cell.
*/
getColumn() {
}
/**
* Gets and sets the column of the cell.
*/
setColumn(value) {
}
/**
* Gets and sets the name of the cell.
*/
getCellName() {
}
/**
* Gets and sets the name of the cell.
*/
setCellName(value) {
}
}
/**
* Represents the collection of cells on this worksheet being watched in the 'watch window'.
*/
class CellWatchCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets and sets CellWatch by index.
* @param {Number} index - The index.
* @return {CellWatch}
*/
get(index) {
}
/**
* Gets and sets CellWatch by the name of the cell.
* @param {String} cellName - The name of the cell.
* @return {CellWatch}
*/
get(cellName) {
}
/**
* Adds CellWatch with row and column.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {Number} Returns the position of this item in the collection.
*/
add(row, column) {
}
/**
* Adds CellWatch with the name the of cell.
* @param {String} cellName - The name of the cell.
* @return {Number}
*/
add(cellName) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the character bullet.
*/
class CharacterBulletValue {
/**
*/
constructor() {
}
/**
* Gets the type of the bullet.
* The value of the property is BulletType integer constant.
*/
getType() {
}
/**
* Gets and sets character of the bullet.
*/
getCharacter() {
}
/**
* Gets and sets character of the bullet.
*/
setCharacter(value) {
}
}
/**
* Encapsulates the object that represents a single Excel chart.
* @example
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* var cells = sheet.getCells();
* cells.get(0, 1).putValue("Income");
* cells.get(1, 0).putValue("Company A");
* cells.get(2, 0).putValue("Company B");
* cells.get(3, 0).putValue("Company C");
* cells.get(1, 1).putValue(10000);
* cells.get(2, 1).putValue(20000);
* cells.get(3, 1).putValue(30000);
* var chartIndex = sheet.getCharts().add(aspose.cells.ChartType.COLUMN, 9, 9, 21, 15);
* var chart = sheet.getCharts().get(chartIndex);
* chart.getNSeries().add("B2:B4", true);
* chart.getNSeries().setCategoryData("A2:A4");
* var aSeries = chart.getNSeries().get(0);
* aSeries.setName("=B1");
* chart.setShowLegend(true);
* chart.getTitle().setText("Income Analysis");
* @hideconstructor
*/
class Chart {
/**
* Gets and sets the builtin style.
* It should be between 1 and 48.
* Return -1 if it's not be set.
*/
getStyle() {
}
/**
* Gets and sets the builtin style.
* It should be between 1 and 48.
* Return -1 if it's not be set.
*/
setStyle(value) {
}
/**
* Represents the chartShape;
*/
getChartObject() {
}
/**
* Indicates whether hide the pivot chart field buttons only when the chart is PivotChart.
*/
getHidePivotFieldButtons() {
}
/**
* Indicates whether hide the pivot chart field buttons only when the chart is PivotChart.
*/
setHidePivotFieldButtons(value) {
}
/**
* Specifies the pivot controls that appear on the chart
*/
getPivotOptions() {
}
/**
* The source is the data of the pivotTable.
* If PivotSource is not empty ,the chart is PivotChart.
* If the pivot table "PivotTable1" in the Worksheet "Sheet1" in the file "Book1.xls".
* The pivotSource could be "[Book1.xls]Sheet1!PivotTable1" if the chart and the PivotTable is not in the same workbook.
* If you set this property ,the previous data source setting will be lost.
*/
getPivotSource() {
}
/**
* The source is the data of the pivotTable.
* If PivotSource is not empty ,the chart is PivotChart.
* If the pivot table "PivotTable1" in the Worksheet "Sheet1" in the file "Book1.xls".
* The pivotSource could be "[Book1.xls]Sheet1!PivotTable1" if the chart and the PivotTable is not in the same workbook.
* If you set this property ,the previous data source setting will be lost.
*/
setPivotSource(value) {
}
/**
* Gets and sets whether plot by row or column.
* The value of the property is PlotDataByType integer constant.
*/
getPlotBy() {
}
/**
* Gets and sets how to plot the empty cells.
* The value of the property is PlotEmptyCellsType integer constant.
*/
getPlotEmptyCellsType() {
}
/**
* Gets and sets how to plot the empty cells.
* The value of the property is PlotEmptyCellsType integer constant.
*/
setPlotEmptyCellsType(value) {
}
/**
* Indicates whether only plot visible cells.
* NOTE: This member is now obsolete. Instead,
* please use PlotVisibleCellsOnly property.
* This method will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPlotVisibleCells() {
}
/**
* Indicates whether only plot visible cells.
* NOTE: This member is now obsolete. Instead,
* please use PlotVisibleCellsOnly property.
* This method will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPlotVisibleCells(value) {
}
/**
* Indicates whether plot visible cells only.
*/
getPlotVisibleCellsOnly() {
}
/**
* Indicates whether plot visible cells only.
*/
setPlotVisibleCellsOnly(value) {
}
/**
* Indicates whether displaying #N/A as blank value.
*/
getDisplayNaAsBlank() {
}
/**
* Indicates whether displaying #N/A as blank value.
*/
setDisplayNaAsBlank(value) {
}
/**
* Gets and sets the name of the chart.
*/
getName() {
}
/**
* Gets and sets the name of the chart.
*/
setName(value) {
}
/**
* True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
*/
getSizeWithWindow() {
}
/**
* True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
*/
setSizeWithWindow(value) {
}
/**
* Gets the worksheet which contains this chart.
*/
getWorksheet() {
}
/**
* Returns all drawing shapes in this chart.
*/
getShapes() {
}
/**
* Gets and sets the printed chart size.
* The value of the property is PrintSizeType integer constant.
*/
getPrintSize() {
}
/**
* Gets and sets the printed chart size.
* The value of the property is PrintSizeType integer constant.
*/
setPrintSize(value) {
}
/**
* Gets or sets a chart's type.
* The value of the property is ChartType integer constant.
*/
getType() {
}
/**
* Gets or sets a chart's type.
* The value of the property is ChartType integer constant.
*/
setType(value) {
}
/**
* Gets a SeriesCollection collection representing the data series in the chart.
*/
getNSeries() {
}
/**
* Gets a SeriesCollection collection representing the data series that are filtered in the chart.
*/
getFilteredNSeries() {
}
/**
* Gets the chart's title.
*/
getTitle() {
}
/**
* Gets the chart's sub-title.
* Only for ODS format file.
*/
getSubTitle() {
}
/**
* Gets the chart's plot area which includes axis tick labels.
*/
getPlotArea() {
}
/**
* Gets the chart area in the worksheet.
*/
getChartArea() {
}
/**
* Gets the chart's X axis.
*/
getCategoryAxis() {
}
/**
* Gets the chart's Y axis.
*/
getValueAxis() {
}
/**
* Gets the chart's second Y axis.
*/
getSecondValueAxis() {
}
/**
* Gets the chart's second X axis.
*/
getSecondCategoryAxis() {
}
/**
* Gets the chart's series axis.
*/
getSeriesAxis() {
}
/**
* Gets the chart legend.
*/
getLegend() {
}
/**
* Represents the chart data table.
*/
getChartDataTable() {
}
/**
* Gets or sets a value indicating whether the chart legend will be displayed. Default is true.
*/
getShowLegend() {
}
/**
* Gets or sets a value indicating whether the chart legend will be displayed. Default is true.
*/
setShowLegend(value) {
}
/**
* Gets or sets a value indicating whether the chart area is rectangular cornered.
* Default is true.
*/
isRectangularCornered() {
}
/**
* Gets or sets a value indicating whether the chart area is rectangular cornered.
* Default is true.
*/
setRectangularCornered(value) {
}
/**
* Gets or sets a value indicating whether the chart displays a data table.
*/
getShowDataTable() {
}
/**
* Gets or sets a value indicating whether the chart displays a data table.
*/
setShowDataTable(value) {
}
/**
* Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).
* Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
*/
getFirstSliceAngle() {
}
/**
* Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).
* Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
*/
setFirstSliceAngle(value) {
}
/**
* Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.
* The value of this property must be between 0 and 500.
*/
getGapWidth() {
}
/**
* Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.
* The value of this property must be between 0 and 500.
*/
setGapWidth(value) {
}
/**
* Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.
* The value of this property must be between 0 and 500.
*/
getGapDepth() {
}
/**
* Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.
* The value of this property must be between 0 and 500.
*/
setGapDepth(value) {
}
/**
* Returns a Floor object that represents the walls of a 3-D chart.
* This property doesn't apply to 3-D pie charts.
*/
getFloor() {
}
/**
* Returns a Walls object that represents the walls of a 3-D chart.
* This property doesn't apply to 3-D pie charts.
*/
getWalls() {
}
/**
* Returns a Walls object that represents the back wall of a 3-D chart.
*/
getBackWall() {
}
/**
* Returns a Walls object that represents the side wall of a 3-D chart.
*/
getSideWall() {
}
/**
* True if gridlines are drawn two-dimensionally on a 3-D chart.
*/
getWallsAndGridlines2D() {
}
/**
* True if gridlines are drawn two-dimensionally on a 3-D chart.
*/
setWallsAndGridlines2D(value) {
}
/**
* Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
* The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44.
* The default value is 20. Applies only to 3-D charts.
*/
getRotationAngle() {
}
/**
* Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
* The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44.
* The default value is 20. Applies only to 3-D charts.
*/
setRotationAngle(value) {
}
/**
* Represents the elevation of the 3-D chart view, in degrees.
* The chart elevation is the height at which you view the chart, in degrees.
* The default is 15 for most chart types.
* The value of this property must be between -90 and 90, except for 3-D bar charts, where it must be between 0 and 44.
*/
getElevation() {
}
/**
* Represents the elevation of the 3-D chart view, in degrees.
* The chart elevation is the height at which you view the chart, in degrees.
* The default is 15 for most chart types.
* The value of this property must be between -90 and 90, except for 3-D bar charts, where it must be between 0 and 44.
*/
setElevation(value) {
}
/**
* True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts).
* If this property is True, the Perspective property is ignored.
*/
getRightAngleAxes() {
}
/**
* True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts).
* If this property is True, the Perspective property is ignored.
*/
setRightAngleAxes(value) {
}
/**
* True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.
* The RightAngleAxes property must be True.
*/
getAutoScaling() {
}
/**
* True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.
* The RightAngleAxes property must be True.
*/
setAutoScaling(value) {
}
/**
* Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
*/
getHeightPercent() {
}
/**
* Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
*/
setHeightPercent(value) {
}
/**
* Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100.
* This property is ignored if the RightAngleAxes property is True.
*/
getPerspective() {
}
/**
* Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100.
* This property is ignored if the RightAngleAxes property is True.
*/
setPerspective(value) {
}
/**
* Indicates whether the chart is a 3d chart.
*/
getIs3D() {
}
/**
* Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
*/
getDepthPercent() {
}
/**
* Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
*/
setDepthPercent(value) {
}
/**
* Gets actual size of chart in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Chart.getActualSize() method.
* This property will be removed 12 months later since July 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {Number[]} Actual size in an array(width and height).
* [0] is width; [1] is height.
*/
getActualChartSize() {
}
/**
* Represents the way the chart is attached to the cells below it.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the chart is attached to the cells below it.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents the page setup description in this chart.
*/
getPageSetup() {
}
/**
* Represents the chartShape;
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Charts.Chart.ChartObject property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getChartShape() {
}
/**
* Gets the line.
*/
getLine() {
}
/**
* Creates the chart image and saves it to a file.
* The extension of the file name determines the format of the image.
* The format of the image is specified by using the extension of the file name.
* For example, if you specify "myfile.png", then the image will be saved
* in the PNG format. The following file extensions are recognized:
* .bmp, .gif, .png, .jpg, .jpeg, .tiff, .tif, .emf.
* If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing.
* @param {String} imageFile - The image file name with full path.
*/
toImage(imageFile) {
}
/**
* Creates the chart image and saves it to a file in the specified format.
* NOTE: This member is now obsolete. Instead,
* please use Chart.ToImage(string, ImageType) method.
* This property will be removed 12 months later since July 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} imageFile - The image file name with full path.
* @param {ImageFormat} imageFormat - The format in which to save the image.
*/
toImage(imageFile, imageFormat) {
}
/**
* Creates the chart image and saves it to a file in the specified image type.
* The type of the image is specified by using imageType.
* The following types are supported:
* ImageType.Bmp, ImageType.Gif, ImageType.Png, ImageType.Jpeg, ImageType.Tiff, ImageType.Emf.
* If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing.
* @param {String} imageFile - The image file name with full path.
* @param {Number} imageType - ImageType
*/
toImage(imageFile, imageType) {
}
/**
* Creates the chart image and saves it to a file in the Jpeg format.
* If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing.
* @param {String} imageFile - The image file name with full path.
* @param {long} jpegQuality - Jpeg quality.
*/
toImage(imageFile, jpegQuality) {
}
/**
* Saves the chart to a pdf file.
* @param {String} fileName - the pdf file name with full path
*/
toPdf(fileName) {
}
/**
* Saves the chart to a pdf file.
* @param {String} fileName - the pdf file name with full path
* @param {Number} desiredPageWidth - The desired page width in inches.
* @param {Number} desiredPageHeight - The desired page height in inches.
* @param {Number} hAlignmentType - PageLayoutAlignmentType
* @param {Number} vAlignmentType - PageLayoutAlignmentType
*/
toPdf(fileName, desiredPageWidth, desiredPageHeight, hAlignmentType, vAlignmentType) {
}
/**
* Creates the chart image and saves it to a file.
* The extension of the file name determines the format of the image.
* The format of the image is specified by using the extension of the file name.
* For example, if you specify "myfile.png", then the image will be saved
* in the PNG format. The following file extensions are recognized:
* .bmp, .gif, .png, .jpg, .jpeg, .tiff, .tif, .emf.
* If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing.
* Please refer to Supported Charts List for more details.
* @param {String} imageFile - The image file name with full path.
* @param {ImageOrPrintOptions} options - Additional image creation options
* @example
* var options = new aspose.cells.ImageOrPrintOptions();
* options.setHorizontalResolution(300);
* options.setVerticalResolution(300);
* var book = new aspose.cells.Workbook("Book1.xls");
* book.getWorksheets().get(0).getCharts().get(0).toImage("chart.png", options);
*/
toImage(imageFile, options) {
}
/**
* Gets actual size of chart in unit of pixels.
* @return {Number[]} Actual size in an array(width and height).
* [0] is width; [1] is height.
*/
getActualSize() {
}
/**
* Returns which axes exist on the chart.
* Normally, Pie, PieExploded, PiePie,PieBar, Pie3D, Pie3DExploded,Doughnut, DoughnutExploded is no axis.
*/
hasAxis(aixsType, isPrimary) {
}
/**
* Switches row/column.
* @return {boolean}
* False means switching row/column fails.
*/
switchRowColumn() {
}
/**
* Gets the data source range of the chart.
* Only supports range.
* @return {String} The data source.
*/
getChartDataRange() {
}
/**
* Specifies data range for a chart.
* @param {String} area - Specifies values from which to plot the data series
* @param {boolean} isVertical - Specifies whether to plot the series from a range of cell values by row or by column.
*/
setChartDataRange(area, isVertical) {
}
/**
* Returns whether the cell refered by the chart.
* NOTE: This method is now obsolete. Instead,
* please use IsCellReferedByChart(int,int,int) method.
* This method will be removed 12 months later since April 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} rowIndex - The row index
* @param {Number} columnIndex - The column index
* @return {boolean}
*/
isReferedByChart(rowIndex, columnIndex) {
}
/**
* Returns whether the cell refered by the chart.
* @param {Number} sheetIndex -
* The sheet Index.-1 means the worksheet which contains current chart.
* @param {Number} rowIndex - The row index
* @param {Number} columnIndex - The column index
* @return {boolean}
*/
isCellReferedByChart(sheetIndex, rowIndex, columnIndex) {
}
/**
* Detects if a chart's data source has changed.
* The method detects the changes in the chart's data source before rendering the chart to image format.
* At first Chart.toImage call, the chart source data (e.g. XValuesParseData, ValuesParseData) will be recorded.
* Before calling the Chart.toImage method again, call IsChartDataChanged method to check if Chart needs re-rendering.
* @return {boolean} Returns true if the chart has changed otherwise returns false
*/
isChartDataChanged() {
}
/**
* Refreshes pivot chart's data from it's pivot data source.
* We will gather data from pivot data source to the pivot chart cache.
* This method is only used to gather all data to a pivot chart.
*/
refreshPivotData() {
}
/**
* Change chart type with preset template.
* @param {byte[]} data - The data of chart template file(.crtx).
*/
changeTemplate(data) {
}
/**
* Moves the chart to a specified location.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} lowerRightColumn - Lower right column index
* @param {Number} lowerRightRow - Lower right row index
*/
move(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Calculates the custom position of plot area, axes if the position of them are auto assigned.
*/
calculate() {
}
/**
* Calculates the custom position of plot area, axes if the position of them are auto assigned, with Chart Calculate Options.
*/
calculate(calculateOptions) {
}
/**
* Creates the chart image and saves it to a stream in the specified format.
* The format of the image is specified by using options.ImageFormat.
* The following formats are supported:
* ImageFormat.Bmp, ImageFormat.Gif, ImageFormat.Png, ImageFormat.Jpeg, ImageFormat.Tiff, ImageFormat.Emf.
* If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing.
* Please refer to Supported Charts List for more details.
* @param {Chart} chart - The Chart object
* @param {WritableStream} stream - The stream of the output image
* @param {ImageOrPrintOptions} options - Addtional image creation options
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var imgOptions = new aspose.cells.ImageOrPrintOptions();
* imgOptions.setHorizontalResolution(200);
* imgOptions.setVerticalResolution(300);
* imgOptions.setImageFormat(aspose.cells.ImageFormat.getJpeg());
* imgWriteStream = fs.createWriteStream("chart.jpeg");
* var chart = workbook.getWorksheets().get("Chart").getCharts().get(0);
* aspose.cells.Chart.toImageStream(chart, imgWriteStream, imgOptions);
*/
static toImageStream(chart, stream, options) {
}
/**
* Creates the chart pdf and saves it to a stream.
* @param {Chart} chart - The Chart object
* @param {WritableStream} stream - The output stream
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var chart = workbook.getWorksheets().get("Chart").getCharts().get(0);
* var imgWriteStream = fs.createWriteStream("chart.pdf");
* aspose.cells.Chart.toPdfStream(chart, imgWriteStream);
*/
static toPdfStream(chart, stream) {
}
}
/**
* Encapsulates the object that represents the chart area in the worksheet.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the first worksheet
* var worksheet = workbook.getWorksheets().get(0);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
* chart.getNSeries().add("A1:B3", true);
* //Getting Chart Area
* var chartArea = chart.getChartArea();
* //Setting the foreground color of the chart area
* chartArea.getArea().setForegroundColor(aspose.cells.Color.getYellow());
* //Setting Chart Area Shadow
* chartArea.setShadow(true);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ChartArea {
/**
* Gets or gets the horizontal offset from its upper left corner column.
*/
getX() {
}
/**
* Gets or gets the horizontal offset from its upper left corner column.
*/
setX(value) {
}
/**
* Gets or gets the vertical offset from its upper left corner row.
*/
getY() {
}
/**
* Gets or gets the vertical offset from its upper left corner row.
*/
setY(value) {
}
/**
* Gets or sets the vertical offset from its lower right corner row.
*/
getHeight() {
}
/**
* Gets or sets the vertical offset from its lower right corner row.
*/
setHeight(value) {
}
/**
* Gets or sets the horizontal offset from its lower right corner column.
*/
getWidth() {
}
/**
* Gets or sets the horizontal offset from its lower right corner column.
*/
setWidth(value) {
}
/**
* Gets a Font object of the specified chartarea object.
*/
getFont() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the area.
*/
getArea() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Set position of the frame to automatic
*/
setPositionAuto() {
}
}
/**
* Represents the options for calculating chart.
*/
class ChartCalculateOptions {
/**
* Creates the options for calculating chart.
*/
constructor() {
}
/**
* 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() {
}
/**
* 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.
*/
setUpdateAllPoints(value) {
}
}
/**
* Encapsulates a collection of Chart objects.
* @example
* var workbook = new aspose.cells.Workbook();
* var charts = workbook.getWorksheets().get(0).getCharts();
* @hideconstructor
*/
class ChartCollection {
/**
*/
getCount() {
}
/**
* Gets the Chart element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Chart} The element at the specified index.
*/
get(index) {
}
/**
* Gets the chart by the name.
* The default chart name is null. So you have to explicitly set the name of the chart.
* @param {String} name - The chart name.
* @return {Chart} The chart.
*/
get(name) {
}
/**
* Adds a chart to the collection.
* @param {Number} type - ChartType
* @param {Number} left - The x offset to corner
* @param {Number} top - The y offset to corner
* @param {Number} width - The chart width
* @param {Number} height - The chart height
* @return {Number} Chart object index.
*/
addFloatingChart(type, left, top, width, height) {
}
/**
* Adds a chart to the collection.
* @param {Number} type - ChartType
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
* @return {Number} Chart object index.
*/
add(type, upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Adds a chart to the collection.
* NOTE: This member is now obsolete. Instead,
* please use add(int, java.lang.String, boolean, int, int, int, int) property.
* This property will be removed 12 months later since May 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} type - ChartType
* @param {String} dataRange - Specifies the data range of the chart
* @param {Number} topRow - Upper left row index.
* @param {Number} leftColumn - Upper left column index.
* @param {Number} rightRow - Lower right row index
* @param {Number} bottomColumn - Lower right column index
* @return {Number} Chart object index.
*/
add(type, dataRange, topRow, leftColumn, rightRow, bottomColumn) {
}
/**
* Adds a chart with preset template.
* @param {byte[]} data - The data of chart template file(.crtx).
* @param {String} dataRange - Specifies the data range of the chart
* @param {boolean} isVertical - Specifies whether to plot the series from a range of cell values by row or by column.
* @param {Number} topRow - Upper left row index.
* @param {Number} leftColumn - Upper left column index.
* @param {Number} rightRow - Lower right row index
* @param {Number} bottomColumn - Lower right column index
* @return {Number} Chart object index.
*/
add(data, dataRange, isVertical, topRow, leftColumn, rightRow, bottomColumn) {
}
/**
* Adds a chart to the collection.
* @param {Number} type - ChartType
* @param {String} dataRange - Specifies the data range of the chart
* @param {boolean} isVertical - Specifies whether to plot the series from a range of cell values by row or by column.
* @param {Number} topRow - Upper left row index.
* @param {Number} leftColumn - Upper left column index.
* @param {Number} rightRow - Lower right row index
* @param {Number} bottomColumn - Lower right column index
* @return {Number} Chart object index.
*/
add(type, dataRange, isVertical, topRow, leftColumn, rightRow, bottomColumn) {
}
/**
* Remove the specific chart.
* @param {Chart} chart
*/
remove(chart) {
}
/**
* Remove a chart at the specific index.
* @param {Number} index - The chart index.
*/
removeAt(index) {
}
/**
* Clear all charts.
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a chart data table.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the first worksheet
* var worksheet = workbook.getWorksheets().get(0);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 25, 10);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
* chart.getNSeries().add("A1:B3", true);
* chart.setShowDataTable(true);
* //Getting Chart Table
* var chartTable = chart.getChartDataTable();
* //Setting Chart Table Font Color
* chartTable.getFont().setColor(aspose.cells.Color.getRed());
* //Setting Legend Key Visibility
* chartTable.setShowLegendKey(false);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ChartDataTable {
/**
* Gets a Font object which represents the font setting of the specified chart data table.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes.
* The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes.
* The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartDataTable.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartDataTable.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* True if the chart data table has horizontal cell borders
*/
hasBorderHorizontal() {
}
/**
* True if the chart data table has horizontal cell borders
*/
setHasBorderHorizontal(value) {
}
/**
* True if the chart data table has vertical cell borders
*/
hasBorderVertical() {
}
/**
* True if the chart data table has vertical cell borders
*/
setHasBorderVertical(value) {
}
/**
* True if the chart data table has outline borders
*/
hasBorderOutline() {
}
/**
* True if the chart data table has outline borders
*/
setHasBorderOutline(value) {
}
/**
* True if the data label legend key is visible.
*/
getShowLegendKey() {
}
/**
* True if the data label legend key is visible.
*/
setShowLegendKey(value) {
}
/**
* Returns a Border object that represents the border of the object
*/
getBorder() {
}
}
/**
* Encapsulates the object that represents the frame object in a chart.
* @hideconstructor
*/
class ChartFrame {
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the Area.
*/
getArea() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* Gets a Font object of the specified ChartFrame object.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
getX() {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
setX(value) {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getY() {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setY(value) {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getHeight() {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setHeight(value) {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
getWidth() {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
setWidth(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Set position of the frame to automatic
*/
setPositionAuto() {
}
}
/**
* Represents the globalization settings for chart.
*/
class ChartGlobalizationSettings {
/**
*/
constructor() {
}
/**
* Gets the name of Series in the Chart.
* @return {String}
*/
getSeriesName() {
}
/**
* Gets the name of Chart Title.
* @return {String}
*/
getChartTitleName() {
}
/**
* Gets the name of increase for Legend.
* @return {String}
*/
getLegendIncreaseName() {
}
/**
* Gets the name of Decrease for Legend.
* @return {String}
*/
getLegendDecreaseName() {
}
/**
* Gets the name of Total for Legend.
* @return {String}
*/
getLegendTotalName() {
}
/**
* Gets the name of Title for Axis.
* @return {String}
*/
getAxisTitleName() {
}
/**
* Gets the name of "Other" labels for Chart.
* @return {String}
*/
getOtherName() {
}
/**
* Gets the Name of Axis Unit.
* @return {String}
*/
getAxisUnitName(type) {
}
}
/**
* Represents a single point in a series in a chart.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the first worksheet
* var worksheet = workbook.getWorksheets().get(0);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.PIE_EXPLODED, 5, 0, 25, 10);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
* chart.getNSeries().add("A1:B3", true);
* //Show Data Labels
* chart.getNSeries().get(0).getDataLabels().setShowValue(true);
* for (var i = 0; i < chart.getNSeries().get(0).getPoints().getCount(); i++)
* {
* //Get Data Point
* var point = chart.getNSeries().get(0).getPoints().get(i);
* //Set Pir Explosion
* point.setExplosion(15);
* //Set Border Color
* point.getBorder().setColor(aspose.cells.Color.getRed());
* }
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ChartPoint {
/**
* The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
*/
getExplosion() {
}
/**
* The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
*/
setExplosion(value) {
}
/**
* True if the chartpoint has a shadow.
*/
getShadow() {
}
/**
* True if the chartpoint has a shadow.
*/
setShadow(value) {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the Area.
*/
getArea() {
}
/**
* Gets the Marker.
*/
getMarker() {
}
/**
* Returns a DataLabels object that represents the data label associated with the point.
*/
getDataLabels() {
}
/**
* Gets or sets the Y value of the chart point.
*/
getYValue() {
}
/**
* Gets or sets the Y value of the chart point.
*/
setYValue(value) {
}
/**
* Gets Y value type of the chart point.
* The value of the property is CellValueType integer constant.
*/
getYValueType() {
}
/**
* Gets or sets the X value of the chart point.
*/
getXValue() {
}
/**
* Gets or sets the X value of the chart point.
*/
setXValue(value) {
}
/**
* Gets X value type of the chart point.
* The value of the property is CellValueType integer constant.
*/
getXValueType() {
}
/**
* Gets the ShapePropertyCollection object that holds the visual shape properties of the ChartPoint.
*/
getShapeProperties() {
}
/**
* Gets or sets a value indicates whether this data points is in the second pie or bar
* on a pie of pie or bar of pie chart
*/
isInSecondaryPlot() {
}
/**
* Gets or sets a value indicates whether this data points is in the second pie or bar
* on a pie of pie or bar of pie chart
*/
setInSecondaryPlot(value) {
}
/**
* Gets the x coordinate of the upper left corner in units of 1/4000 of chart's width after calls Chart.Calculate() method.
*/
getShapeX() {
}
/**
* Gets the y coordinate of the upper left corner in units of 1/4000 of chart's height after calls Chart.Calculate() method.
*/
getShapeY() {
}
/**
* Gets the width in units of 1/4000 of chart's width after calls Chart.Calculate() method.
*/
getShapeWidth() {
}
/**
* Gets the height in units of 1/4000 of chart's height after calls Chart.Calculate() method.
*/
getShapeHeight() {
}
/**
* Gets the x coordinate of the upper left corner in units of pixels after calls Chart.Calculate() method.
*/
getShapeXPx() {
}
/**
* Gets the y coordinate of the upper left corner in units of pixels after calls Chart.Calculate() method.
*/
getShapeYPx() {
}
/**
* Gets the width in units of pixels after calls Chart.Calculate() method.
*/
getShapeWidthPx() {
}
/**
* Gets the height in units of pixels after calls Chart.Calculate() method.
*/
getShapeHeightPx() {
}
/**
* Gets the width of border in units of pixels after calls Chart.Calculate() method.
*/
getBorderWidthPx() {
}
/**
* Gets the radius of bubble, pie or doughnut in units of pixels after calls Chart.Calculate() method.
*/
getRadiusPx() {
}
/**
* Gets the inner radius of doughnut slice in units of pixels after calls Chart.Calculate() method.
* Applies to Doughnut chart.
*/
getInnerRadiusPx() {
}
/**
* Gets the starting angle for the pie section, measured in degrees clockwise from the x-axis after calls Chart.Calculate() method.
* Applies to Pie chart.
*/
getStartAngle() {
}
/**
* Gets the ending angle for the pie section, measured in degrees clockwise from the x-axis after calls Chart.Calculate() method.
* Applies to Pie chart.
*/
getEndAngle() {
}
/**
* Gets the x coordinate of starting point for the pie section after calls Chart.Calculate() method.
* Applies to Pie and Doughnut chart.
*/
getArcStartPointXPx() {
}
/**
* Gets the y coordinate of starting point for the pie section after calls Chart.Calculate() method.
* Applies to Pie and Doughnut chart.
*/
getArcStartPointYPx() {
}
/**
* Gets the x coordinate of ending point for the pie section after calls Chart.Calculate() method.
* Applies to Pie and Doughnut chart.
*/
getArcEndPointXPx() {
}
/**
* Gets the y coordinate of ending point for the pie section after calls Chart.Calculate() method.
* Applies to Pie and Doughnut chart.
*/
getArcEndPointYPx() {
}
/**
* Gets the x coordinate of starting point for the pie section after calls Chart.Calculate() method.
* Applies to Doughnut chart.
*/
getInnerArcStartPointXPx() {
}
/**
* Gets the y coordinate of starting point for the pie section after calls Chart.Calculate() method.
* Applies to Doughnut chart.
*/
getInnerArcStartPointYPx() {
}
/**
* Gets the x coordinate of ending point for the pie section after calls Chart.Calculate() method.
* Applies to Doughnut chart.
*/
getInnerArcEndPointXPx() {
}
/**
* Gets the y coordinate of ending point for the pie section after calls Chart.Calculate() method.
* Applies to Doughnut chart.
*/
getInnerArcEndPointYPx() {
}
/**
* Gets the number of top points after calls Chart.Calculate() method.
*/
getTopPointCount() {
}
/**
* Gets x-coordinate of the top point of shape after calls Chart.Calculate() method.
* Applies 3D charts: Column3D, Bar3D, Cone, Cylinder, Pyramid and Area3D
*/
getTopPointXPx(index) {
}
/**
* Gets y-coordinate of the top point of shape after calls Chart.Calculate() method.
* Applies 3D charts: Column3D, Bar3D, Cone, Cylinder, Pyramid and Area3D
*/
getTopPointYPx(index) {
}
/**
* Gets the number of bottom points after calls Chart.Calculate() method.
*/
getBottomPointCount() {
}
/**
* Gets x-coordinate of the bottom point of shape after calls Chart.Calculate() method.
* Applies 3D charts: Column3D, Bar3D, Cone, Cylinder, Pyramid
*/
getBottomPointXPx(index) {
}
/**
* Gets y-coordinate of the bottom point of shape after calls Chart.Calculate() method.
* Applies 3D charts: Column3D, Bar3D, Cone, Cylinder, Pyramid
*/
getBottomPointYPx(index) {
}
/**
* Gets the number of the points on category axis after calls Chart.Calculate() method. Only applies to area chart.
* Area 2D chart return 1
* Area 3D chart return 2.
*/
getOnCategoryAxisPointCount() {
}
/**
* Gets x-coordinate of the point on category axis after calls Chart.Calculate() method. Only applies to Area chart.
* Area 2D chart: index is 0.
* Area 3D chart: index is 0 or 1.
*/
getOnCategoryAxisPointXPx(index) {
}
/**
* Gets y-coordinate of the point on category axis after calls Chart.Calculate() method. Only applies to Area chart.
* Area 2D chart: index is 0.
* Area 3D chart: index is 0 or 1.
*/
getOnCategoryAxisPointYPx(index) {
}
}
/**
* Represents a collection that contains all the points in one series.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the first worksheet
* var worksheet = workbook.getWorksheets().get(0);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.PIE_EXPLODED, 5, 0, 25, 10);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
* chart.getNSeries().add("A1:B3", true);
* //Show Data Labels
* chart.getNSeries().get(0).getDataLabels().setShowValue(true);
* var points = chart.getNSeries().get(0).getPoints();
* for (var i = 0; i < points.getCount(); i++)
* {
* //Get Data Point
* var point = points.get(i);
* //Set Pir Explosion
* point.setExplosion(15);
* //Set Border Color
* point.getBorder().setColor(aspose.cells.Color.getRed());
* }
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ChartPointCollection {
/**
* Gets the count of the chart point.
*/
getCount() {
}
/**
* Gets the ChartPoint element at the specified index in the series.
* @param {Number} index - The index of chart point in the series.
* @return {ChartPoint} The ChartPoint object.
*/
get(index) {
}
/**
* Returns an enumerator for the entire ChartPointCollection.
* @return {Iterator}
*/
iterator() {
}
/**
* Remove all setting of the chart points.
*/
clear() {
}
/**
* Removes point at the index of the series..
* @param {Number} index - The index of the point.
*/
removeAt(index) {
}
}
/**
* Represents the shape of the chart.
* Properties and methods for the ChartObject object control the appearance and size of the embedded chart on the worksheet.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the first worksheet
* var worksheet = workbook.getWorksheets().get(0);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.PIE_EXPLODED, 5, 0, 25, 10);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
* chart.getNSeries().add("A1:B3", true);
* //Show Data Labels
* chart.getNSeries().get(0).getDataLabels().setShowValue(true);
* //Getting Chart Shape
* var chartShape = chart.getChartObject();
* //Set Lower Right Column
* chartShape.setLowerRightColumn(10);
* //Set LowerDeltaX
* chartShape.setLowerDeltaX(1024);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ChartShape {
/**
* Returns a Chart object that represents the chart contained in the object.
*/
getChart() {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Encapsulates the object that represents the frame object which contains text.
* @hideconstructor
*/
class ChartTextFrame {
/**
* Indicates the text is auto generated.
*/
isAutoText() {
}
/**
* Indicates the text is auto generated.
*/
setAutoText(value) {
}
/**
* Indicates whether this data labels is deleted.
*/
isDeleted() {
}
/**
* Indicates whether this data labels is deleted.
*/
setDeleted(value) {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
getRotationAngle() {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
setRotationAngle(value) {
}
/**
* Indicates whether the text of the chart is automatically rotated.
*/
isAutomaticRotation() {
}
/**
* Gets or sets the text of a frame's title.
*/
getText() {
}
/**
* Gets or sets the text of a frame's title.
*/
setText(value) {
}
/**
* Gets and sets a reference to the worksheet.
*/
getLinkedSource() {
}
/**
* Gets and sets a reference to the worksheet.
*/
setLinkedSource(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextDirection() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTextDirection(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
getReadingOrder() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
setReadingOrder(value) {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
getDirectionType() {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
setDirectionType(value) {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
isTextWrapped() {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
setTextWrapped(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setResizeShapeToFitText(value) {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the area.
*/
getArea() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* Gets a Font object of the specified ChartFrame object.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
getX() {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
setX(value) {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getY() {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setY(value) {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getHeight() {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setHeight(value) {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
getWidth() {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
setWidth(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Set position of the frame to automatic
*/
setPositionAuto() {
}
}
/**
* Represents a check box object in a worksheet.
* @example
* var index = excel.getWorksheets().get(0).getCheckBoxes().add(15, 15, 20, 100);
* var checkBox = excel.getWorksheets().get(0).getCheckBoxes().get(index);
* checkBox.setText("Check Box 1");
* @hideconstructor
*/
class CheckBox {
/**
* Indicates if the checkbox is checked or not.
*/
getValue() {
}
/**
* Indicates if the checkbox is checked or not.
*/
setValue(value) {
}
/**
* Gets or set checkbox' value.
* The value of the property is CheckValueType integer constant.NOTE: This member is now obsolete. Instead,
* please use CheckBox.CheckValueType property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getCheckValue() {
}
/**
* Gets or set checkbox' value.
* The value of the property is CheckValueType integer constant.NOTE: This member is now obsolete. Instead,
* please use CheckBox.CheckValueType property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCheckValue(value) {
}
/**
* Gets or set checkbox' value.
* The value of the property is CheckValueType integer constant.
*/
getCheckedValue() {
}
/**
* Gets or set checkbox' value.
* The value of the property is CheckValueType integer constant.
*/
setCheckedValue(value) {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
getShadow() {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
setShadow(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a CheckBox ActiveX control.
* @hideconstructor
*/
class CheckBoxActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and sets the group's name.
*/
getGroupName() {
}
/**
* Gets and sets the group's name.
*/
setGroupName(value) {
}
/**
* Gets and set the position of the Caption relative to the control.
* The value of the property is ControlCaptionAlignmentType integer constant.
*/
getAlignment() {
}
/**
* Gets and set the position of the Caption relative to the control.
* The value of the property is ControlCaptionAlignmentType integer constant.
*/
setAlignment(value) {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
isWordWrapped() {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
setWordWrapped(value) {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
getCaption() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
setCaption(value) {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
getPicturePosition() {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
setPicturePosition(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Gets and sets the data of the picture.
*/
getPicture() {
}
/**
* Gets and sets the data of the picture.
*/
setPicture(value) {
}
/**
* Gets and sets the accelerator key for the control.
*/
getAccelerator() {
}
/**
* Gets and sets the accelerator key for the control.
*/
setAccelerator(value) {
}
/**
* Indicates if the control is checked or not.
* The value of the property is CheckValueType integer constant.
*/
getValue() {
}
/**
* Indicates if the control is checked or not.
* The value of the property is CheckValueType integer constant.
*/
setValue(value) {
}
/**
* Indicates how the specified control will display Null values.
* SettingDescriptionTrueThe 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() {
}
/**
* Indicates how the specified control will display Null values.
* SettingDescriptionTrueThe 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.
*/
setTripleState(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Represents a collection of CheckBox objects in a worksheet.
* @example
* var index = excel.getWorksheets().get(0).getCheckBoxes().add(15, 15, 20, 100);
* var checkBox = excel.getWorksheets().get(0).getCheckBoxes().get(index);
* checkBox.setText("Check Box 1");
* @hideconstructor
*/
class CheckBoxCollection {
/**
*/
getCount() {
}
/**
* Gets the CheckBox element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {CheckBox} The element at the specified index.
*/
get(index) {
}
/**
* Adds a checkBox to the collection.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} height - Height of checkBox, in unit of pixel.
* @param {Number} width - Width of checkBox, in unit of pixel.
* @return {Number} CheckBox object index.
*/
add(upperLeftRow, upperLeftColumn, height, width) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Provides the abstract base class for a strongly typed collection.
*/
class CollectionBase {
/**
* Initializes a new instance of the CollectionBase class with the default initial capacity.
*/
constructor() {
}
/**
* Initializes a new instance of the CollectionBase class with the specified capacity.
* @param {Number} capacity - The number of elements that the new list can initially store.
*/
constructor_overload$1(capacity) {
}
/**
* Returns an enumerator that iterates through the CollectionBase instance.
* @return {Iterator} An iterator for the CollectionBase instance.
*/
iterator() {
}
/**
* Gets the number of elements contained in the CollectionBase instance.
* @return {Number} The number of elements contained in the CollectionBase instance.
*/
getCount() {
}
/**
* Removes all objects from the CollectionBase instance.
*/
clear() {
}
/**
* Adds an item to the CollectionBase instance.
* @param {Object} o - The Object to add to the CollectionBase instance.
* @return {Number} The position into which the new element was inserted.
*/
add(o) {
}
/**
* Get an item at specified position.
* @param {Number} index - Specified position index.
* @return {Object} The item at specified position.
*/
get(index) {
}
/**
* Return whether instance contains this object
* @param {Object} o - test object
* @return {boolean} Whether instance contains this object
*/
contains(o) {
}
/**
* Removes the item at the specified index.
* @param {Number} index - The zero-based index of the item to remove.
*/
removeAt(index) {
}
/**
* Determines the index of a specific item in the CollectionBase instance.
* @param {Object} o - Determines the index of a specific item in the CollectionBase instance.
* @return {Number} The index of value if found in the list; otherwise, -1.
*/
indexOf(o) {
}
}
/**
* Represents an ARGB (alpha, red, green, blue) color.
*/
class Color {
/**
* construct function
*/
constructor() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSienna() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSilver() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSkyBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSlateBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSlateGray() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSnow() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSpringGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSteelBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getTan() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getTeal() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getThistle() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getTomato() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getTransparent() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getTurquoise() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getViolet() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getWheat() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getWhite() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getWhiteSmoke() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getYellow() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getYellowGreen() {
}
/**
* Gets the alpha component value of this Color object.
* @return {byte} The alpha component value of this Color object.
*/
getA() {
}
/**
* Gets the red component value of this Color object.
* @return {byte} The red component value of this Color object.
*/
getR() {
}
/**
* Gets the green component value of this Color object.
* @return {byte} The green component value of this Color object.
*/
getG() {
}
/**
* Gets the blue component value of this Color object.
* @return {byte} The blue component value of this Color object.
*/
getB() {
}
/**
* Specifies whether this Color object is uninitialized.
* @return {boolean} This property returns true if this color is uninitialized; otherwise, false.
*/
isEmpty() {
}
/**
* Gets the 32-bit ARGB value of this Color object.
* @return {Number} The 32-bit ARGB value of this Color object.
*/
toArgb() {
}
/**
* Tests whether the specified object is a Color object and is equivalent to this object.
* @param {Object} obj - The object to test.
* @return {boolean} true if obj is a Color object and equivalent to this Color object; otherwise, false.
*/
equals(obj) {
}
/**
* Returns a hash code for this Color object.
* @return {Number} An integer value that specifies the hash code for this Color object.
*/
hashCode() {
}
/**
* Creates a Color object from a 32-bit ARGB value.
* @param {Number} argb - A value specifying the 32-bit ARGB value.
* @return {Color} The Color object that this method creates.
*/
static fromArgb(argb) {
}
/**
* Creates a Color object from the specified 8-bit color values
* (red, green, and blue). The alpha value is implicitly 255 (fully opaque).
* Although this method allows a 32-bit value to be passed for each color component,
* the value of each component is limited to 8 bits.
* @param {Number} red - The red component value for the new Color object. Valid values are 0 through 255.
* @param {Number} green - The green component value for the new Color object. Valid values are 0 through 255.
* @param {Number} blue - The blue component value for the new Color object. Valid values are 0 through 255.
* @return {Color} The Color object that this method creates.
*/
static fromArgb(red, green, blue) {
}
/**
* Creates a Color object from the four ARGB component (alpha,red, green, and blue) values. Although this method allows a 32-bit value
* to be passed for each component, the value of each component is limited to 8 bits.
* @param {Number} alpha - The alpha component. Valid values are 0 through 255.
* @param {Number} red - The red component. Valid values are 0 through 255.
* @param {Number} green - The green component. Valid values are 0 through 255.
* @param {Number} blue - The blue component. Valid values are 0 through 255.
* @return {Color} The Color object that this method creates.
*/
static fromArgb(alpha, red, green, blue) {
}
/**
* Get a system-defined empty color.
* @return {Color} A Color object representing a system-defined color.
*/
static getEmpty() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getAliceBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getAntiqueWhite() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getAzure() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getAquamarine() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getAqua() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBeige() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBisque() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBlack() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBlanchedAlmond() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBlueViolet() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBrown() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getCadetBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getBurlyWood() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getChartreuse() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getChocolate() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getCoral() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getCornflowerBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getCornsilk() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getCrimson() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getCyan() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkCyan() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkGoldenrod() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkGray() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkKhaki() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkMagenta() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkOliveGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkOrange() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkOrchid() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkRed() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkSalmon() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkSeaGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkSlateBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkSlateGray() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkTurquoise() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDarkViolet() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDeepPink() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDeepSkyBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDimGray() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getDodgerBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getFirebrick() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getFloralWhite() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getForestGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getFuchsia() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getGainsboro() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getGhostWhite() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getGold() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getGoldenrod() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getGray() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getGreenYellow() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getHoneydew() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getHotPink() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getIndianRed() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getIndigo() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getIvory() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getKhaki() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLavender() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLavenderBlush() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLawnGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLemonChiffon() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightCoral() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightCyan() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightGoldenrodYellow() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightGray() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightPink() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightSalmon() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightSeaGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightSkyBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightSlateGray() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightSteelBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLightYellow() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLime() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLimeGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getLinen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMagenta() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMaroon() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumAquamarine() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumOrchid() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumPurple() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumSeaGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumSlateBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumSpringGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumTurquoise() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMediumVioletRed() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMidnightBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMintCream() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMistyRose() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getMoccasin() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getNavajoWhite() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getNavy() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getOldLace() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getOlive() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getOliveDrab() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getOrange() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getOrangeRed() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getOrchid() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPaleGoldenrod() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPaleGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPaleTurquoise() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPaleVioletRed() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPapayaWhip() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPeachPuff() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPeru() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPink() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPlum() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPowderBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getPurple() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getRed() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getRosyBrown() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getRoyalBlue() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSaddleBrown() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSalmon() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSandyBrown() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSeaGreen() {
}
/**
* Get a system-defined color.
* @return {Color} A Color object representing a system-defined color.
*/
static getSeaShell() {
}
}
/**
* Represents filtering the range by color.
* @hideconstructor
*/
class ColorFilter {
/**
* Whether filter by the cell's fill color.
* True: cell's fill color; False: cell's font color.
*/
getFilterByFillColor() {
}
/**
* Whether filter by the cell's fill color.
* True: cell's fill color; False: cell's font color.
*/
setFilterByFillColor(value) {
}
/**
* Gets the color of this filter.
* @param {WorksheetCollection} sheets
* @return {Color}
*/
getColor(sheets) {
}
}
/**
* Provides helper functions about color.
* @hideconstructor
*/
class ColorHelper {
/**
* Convert OLE_COLOR.
* @param {Number} oleColor - The value of OLE_COLOR.
* @return {Color} The com.aspose.cells.Color object.
*/
static fromOleColor(oleColor) {
}
/**
* Convert color to OLE_COLOR
* @param {Color} color - The
* @param {Workbook} workbook
* @return {Number} The value of OLE_COLOR
*/
static toOleColor(color, workbook) {
}
}
/**
* Describe the ColorScale conditional formatting rule.
* This conditional formatting rule creates a gradated color scale on the cells.
* @hideconstructor
*/
class ColorScale {
/**
* Indicates whether conditional formatting is 3 color scale.
*/
getIs3ColorScale() {
}
/**
* Indicates whether conditional formatting is 3 color scale.
*/
setIs3ColorScale(value) {
}
/**
* Get or set this ColorScale's min value object.
* Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
*/
getMinCfvo() {
}
/**
* Get or set this ColorScale's mid value object.
* Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it.
*/
getMidCfvo() {
}
/**
* Get or set this ColorScale's max value object.
* Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
*/
getMaxCfvo() {
}
/**
* Get or set the gradient color for the minimum value in the range.
*/
getMinColor() {
}
/**
* Get or set the gradient color for the minimum value in the range.
*/
setMinColor(value) {
}
/**
* Get or set the gradient color for the middle value in the range.
*/
getMidColor() {
}
/**
* Get or set the gradient color for the middle value in the range.
*/
setMidColor(value) {
}
/**
* Get or set the gradient color for the maximum value in the range.
*/
getMaxColor() {
}
/**
* Get or set the gradient color for the maximum value in the range.
*/
setMaxColor(value) {
}
}
/**
* Represents a single column in a worksheet.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the first worksheet
* var worksheet = workbook.getWorksheets().get(0);
* //Add new Style to Workbook
* var style = workbook.createStyle();
* //Setting the background color to Blue
* style.setBackgroundColor(aspose.cells.Color.getBlue());
* //Setting the foreground color to Red
* style.setForegroundColor(aspose.cells.Color.getRed());
* //setting Background Pattern
* style.setPattern(aspose.cells.BackgroundType.DIAGONAL_STRIPE);
* //New Style Flag
* var styleFlag = new aspose.cells.StyleFlag();
* //Set All Styles
* styleFlag.setAll(true);
* //Get first Column
* var column = worksheet.getCells().getColumns().get(0);
* //Apply Style to first Column
* column.applyStyle(style, styleFlag);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Column {
/**
* Gets the index of this column.
*/
getIndex() {
}
/**
* Gets and sets the column width in unit of characters.
* 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() {
}
/**
* Gets and sets the column width in unit of characters.
* 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) {
}
/**
* Gets the group level of the column.
*/
getGroupLevel() {
}
/**
* Gets the group level of the column.
*/
setGroupLevel(value) {
}
/**
* Indicates whether the column is hidden.
*/
isHidden() {
}
/**
* Indicates whether the column is hidden.
*/
setHidden(value) {
}
/**
* Indicates whether this column has custom style settings(different from the default one inherited from workbook).
*/
hasCustomStyle() {
}
/**
* whether the column is collapsed
*/
isCollapsed() {
}
/**
* whether the column is collapsed
*/
setCollapsed(value) {
}
/**
* Applies formats for a whole column.
* @param {Style} style - The style object which will be applied.
* @param {StyleFlag} flag - Flags which indicates applied formatting properties.
*/
applyStyle(style, flag) {
}
/**
* Gets the style of this column.
* Modifying the returned style object directly takes no effect for this column or any cells in this column.
* You have to call applyStyle(com.aspose.cells.Style, com.aspose.cells.StyleFlag) or setStyle(com.aspose.cells.Style) 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() {
}
/**
* Sets the style of this column.
* 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 applyStyle(com.aspose.cells.Style, com.aspose.cells.StyleFlag)
* @param {Style} style - the style to be used as the default style for cells in this column.
*/
setStyle(style) {
}
}
/**
* Collection of the Column 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.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the first worksheet
* var worksheet = workbook.getWorksheets().get(0);
* //Add new Style to Workbook
* var style = workbook.createStyle();
* //Setting the background color to Blue
* style.setForegroundColor(aspose.cells.Color.getBlue());
* //setting Background Pattern
* style.setPattern(aspose.cells.BackgroundType.SOLID);
* //New Style Flag
* var styleFlag = new aspose.cells.StyleFlag();
* //Set All Styles
* styleFlag.setAll(true);
* //Change the default width of first ten columns
* for (var i = 0; i < 10; i++)
* {
* worksheet.getCells().getColumns().get(i).setWidth(20);
* }
* //Get the Column with non default formatting
* var columns = worksheet.getCells().getColumns();
* for (var o = columns.iterator(); o.hasNext();)
* {
* var column = o.next();
* //Apply Style to first ten Columns
* column.applyStyle(style, styleFlag);
* }
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ColumnCollection {
/**
*/
getCount() {
}
/**
* Gets a Column object by column index.
* The Column object of given column index will be instantiated if it does not exist before.
*/
get(columnIndex) {
}
/**
* Gets the column object by the index.
* NOTE: This member is now obsolete. Instead,
* please use Columns.GetColumnByIndex() method.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} index
* @return {Column} Returns the column object.
*/
getByIndex(index) {
}
/**
* Gets the Column object by the position in the list.
* @param {Number} index - The position in the list.
* @return {Column} Returns the column object.
*/
getColumnByIndex(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the control form ComboBox.
* @example
* //Create a new Workbook.
* var workbook = new aspose.cells.Workbook();
* //Get the first worksheet.
* var sheet = workbook.getWorksheets().get(0);
* //Get the worksheet cells collection.
* var cells = sheet.getCells();
* //Input a value.
* cells.get("B3").putValue("Employee:");
* //Set it bold.
* cells.get("B3").getStyle().getFont().setBold(true);
* //Input some values that denote the input range
* //for the combo box.
* cells.get("A2").putValue("Emp001");
* cells.get("A3").putValue("Emp002");
* cells.get("A4").putValue("Emp003");
* cells.get("A5").putValue("Emp004");
* cells.get("A6").putValue("Emp005");
* cells.get("A7").putValue("Emp006");
* //Add a new combo box.
* var comboBox = sheet.getShapes().addShape(aspose.cells.MsoDrawingType.COMBO_BOX, 2, 0, 2, 0, 22, 100);
* //Set the linked cell;
* comboBox.setLinkedCell("A1");
* //Set the input range.
* comboBox.setInputRange("A2:A7");
* //Set no. of list lines displayed in the combo
* //box's list portion.
* comboBox.setDropDownLines(5);
* //Set the combo box with 3-D shading.
* comboBox.setShadow(true);
* //AutoFit Columns
* sheet.autoFitColumns();
* //Saves the file.
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ComboBox {
/**
* Gets or sets the index number of the currently selected item in a list box or combo box.
* Zero-based.
* -1 presents no item is selected.
*/
getSelectedIndex() {
}
/**
* Gets or sets the index number of the currently selected item in a list box or combo box.
* Zero-based.
* -1 presents no item is selected.
*/
setSelectedIndex(value) {
}
/**
* Gets the selected value of the combox box.
*/
getSelectedValue() {
}
/**
* Gets the selected cell in the input range of the combo box.
*/
getSelectedCell() {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
getShadow() {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
setShadow(value) {
}
/**
* Gets or sets the number of list lines displayed in the drop-down portion of a combo box.
*/
getDropDownLines() {
}
/**
* Gets or sets the number of list lines displayed in the drop-down portion of a combo box.
*/
setDropDownLines(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a ComboBox ActiveX control.
* @hideconstructor
*/
class ComboBoxActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and sets the maximum number of characters
*/
getMaxLength() {
}
/**
* Gets and sets the maximum number of characters
*/
setMaxLength(value) {
}
/**
* Gets and set the width in unit of points.
*/
getListWidth() {
}
/**
* Gets and set the width in unit of points.
*/
setListWidth(value) {
}
/**
* Represents how the Value property is determined for a ComboBox or ListBox
* when the MultiSelect properties value (fmMultiSelectSingle).
*/
getBoundColumn() {
}
/**
* Represents how the Value property is determined for a ComboBox or ListBox
* when the MultiSelect properties value (fmMultiSelectSingle).
*/
setBoundColumn(value) {
}
/**
* Represents the column in a ComboBox or ListBox to display to the user.
*/
getTextColumn() {
}
/**
* Represents the column in a ComboBox or ListBox to display to the user.
*/
setTextColumn(value) {
}
/**
* Represents the number of columns to display in a ComboBox or ListBox.
*/
getColumnCount() {
}
/**
* Represents the number of columns to display in a ComboBox or ListBox.
*/
setColumnCount(value) {
}
/**
* Represents the maximum number of rows to display in the list.
*/
getListRows() {
}
/**
* Represents the maximum number of rows to display in the list.
*/
setListRows(value) {
}
/**
* Indicates how a ListBox or ComboBox searches its list as the user types.
* The value of the property is ControlMatchEntryType integer constant.
*/
getMatchEntry() {
}
/**
* Indicates how a ListBox or ComboBox searches its list as the user types.
* The value of the property is ControlMatchEntryType integer constant.
*/
setMatchEntry(value) {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is DropButtonStyle integer constant.
*/
getDropButtonStyle() {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is DropButtonStyle integer constant.
*/
setDropButtonStyle(value) {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is ShowDropButtonType integer constant.
*/
getShowDropButtonTypeWhen() {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is ShowDropButtonType integer constant.
*/
setShowDropButtonTypeWhen(value) {
}
/**
* Gets and sets the visual appearance.
* The value of the property is ControlListStyle integer constant.
*/
getListStyle() {
}
/**
* Gets and sets the visual appearance.
* The value of the property is ControlListStyle integer constant.
*/
setListStyle(value) {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
getBorderStyle() {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
setBorderStyle(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBorderOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBorderOleColor(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Indicates whether the user can type into the control.
*/
isEditable() {
}
/**
* Indicates whether the user can type into the control.
*/
setEditable(value) {
}
/**
* Indicates whether column headings are displayed.
*/
getShowColumnHeads() {
}
/**
* Indicates whether column headings are displayed.
*/
setShowColumnHeads(value) {
}
/**
* Indicates whether dragging and dropping is enabled for the control.
*/
isDragBehaviorEnabled() {
}
/**
* Indicates whether dragging and dropping is enabled for the control.
*/
setDragBehaviorEnabled(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setEnterFieldBehavior(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAutoWordSelected(value) {
}
/**
* Indicates whether the user can select a line of text by clicking in the region to the left of the text.
*/
getSelectionMargin() {
}
/**
* Indicates whether the user can select a line of text by clicking in the region to the left of the text.
*/
setSelectionMargin(value) {
}
/**
* Gets and sets the value of the control.
*/
getValue() {
}
/**
* Gets and sets the value of the control.
*/
setValue(value) {
}
/**
* Indicates whether selected text in the control appears highlighted when the control does not have focus.
*/
getHideSelection() {
}
/**
* Indicates whether selected text in the control appears highlighted when the control does not have focus.
*/
setHideSelection(value) {
}
/**
* Gets and sets the width of the column.
*/
getColumnWidths() {
}
/**
* Gets and sets the width of the column.
*/
setColumnWidths(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Represents a command button.
* @hideconstructor
*/
class CommandButtonActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
getCaption() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
setCaption(value) {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
getPicturePosition() {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
setPicturePosition(value) {
}
/**
* Gets and sets the data of the picture.
*/
getPicture() {
}
/**
* Gets and sets the data of the picture.
*/
setPicture(value) {
}
/**
* Gets and sets the accelerator key for the control.
*/
getAccelerator() {
}
/**
* Gets and sets the accelerator key for the control.
*/
setAccelerator(value) {
}
/**
* Indicates whether the control takes the focus when clicked.
*/
getTakeFocusOnClick() {
}
/**
* Indicates whether the control takes the focus when clicked.
*/
setTakeFocusOnClick(value) {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
isWordWrapped() {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
setWordWrapped(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Encapsulates the object that represents a cell comment.
* @example
* var workbook = new aspose.cells.Workbook();
* var comments = workbook.getWorksheets().get(0).getComments();
* //Add comment to cell A1
* var commentIndex = comments.add(0, 0);
* var comment = comments.get(commentIndex);
* comment.setNote("First note.");
* comment.getFont().setName("Times New Roman");
* //Add comment to cell B2
* comments.add("B2");
* comment = comments.get("B2");
* comment.setNote("Second note.");
* @hideconstructor
*/
class Comment {
/**
* Gets and sets Name of the original comment author
*/
getAuthor() {
}
/**
* Gets and sets Name of the original comment author
*/
setAuthor(value) {
}
/**
* Get a Shape object that represents the shape attached to the specified comment.
*/
getCommentShape() {
}
/**
* Gets the row index of the comment.
*/
getRow() {
}
/**
* Gets the column index of the comment.
*/
getColumn() {
}
/**
* Indicates whether this comment is a threaded comment.
*/
isThreadedComment() {
}
/**
* Gets the list of threaded comments;
*/
getThreadedComments() {
}
/**
* Represents the content of comment.
* If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
*/
getNote() {
}
/**
* Represents the content of comment.
* If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
*/
setNote(value) {
}
/**
* Gets and sets the html string which contains data and some formats in this comment.
* If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
*/
getHtmlNote() {
}
/**
* Gets and sets the html string which contains data and some formats in this comment.
* If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.
*/
setHtmlNote(value) {
}
/**
* Gets the font of comment.
*/
getFont() {
}
/**
* Represents if the comment is visible or not.
*/
isVisible() {
}
/**
* Represents if the comment is visible or not.
*/
setVisible(value) {
}
/**
* Gets and sets the text orientation type of the comment.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the comment.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the comment.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the comment.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the comment.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the comment.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Indicates if size of comment is adjusted automatically according to its content.
*/
getAutoSize() {
}
/**
* Indicates if size of comment is adjusted automatically according to its content.
*/
setAutoSize(value) {
}
/**
* Represents the height of the comment, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the comment, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the width of the comment, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the comment, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the width of the comment, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of the comment, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the Height of the comment, in unit of pixels.
*/
getHeight() {
}
/**
* Represents the Height of the comment, in unit of pixels.
*/
setHeight(value) {
}
/**
* Represents the width of the comment, in unit of inches.
*/
getWidthInch() {
}
/**
* Represents the width of the comment, in unit of inches.
*/
setWidthInch(value) {
}
/**
* Represents the height of the comment, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the comment, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Format some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Returns a Characters object that represents a range of characters within the comment text.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the comment text.
* NOTE: This method is now obsolete. Instead,
* please use Comment.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the comment text.
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
}
/**
* Encapsulates a collection of Comment objects.
* @example
* var workbook = new aspose.cells.Workbook();
* var comments = workbook.getWorksheets().get(0).getComments();
* @hideconstructor
*/
class CommentCollection {
/**
*/
getCount() {
}
/**
* Gets the Comment element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Comment} The element at the specified index.
*/
get(index) {
}
/**
* Gets the Comment element at the specified cell.
* @param {String} cellName - Cell name.
* @return {Comment} The element at the specified cell.
*/
get(cellName) {
}
/**
* Gets the Comment element at the specified row index and column index.
* @param {Number} row - Row index.
* @param {Number} column - Column index.
* @return {Comment} The element at the specified cell.
*/
get(row, column) {
}
/**
* Adds a threaded comment.
* @param {Number} row - Cell row index.
* @param {Number} column - Cell column index.
* @param {String} text - The text of the comment
* @param {ThreadedCommentAuthor} author - The user of this threaded comment.
* @return {Number} ThreadedComment object index.
*/
addThreadedComment(row, column, text, author) {
}
/**
* Adds a threaded comment.
* @param {String} cellName - The name of the cell.
* @param {String} text - The text of the comment
* @param {ThreadedCommentAuthor} author - The user of this threaded comment.
* @return {Number} ThreadedComment object index.
*/
addThreadedComment(cellName, text, author) {
}
/**
* Gets the threaded comments by row and column index.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {ThreadedCommentCollection}
*/
getThreadedComments(row, column) {
}
/**
* Gets the threaded comments by cell name.
* @param {String} cellName - The name of the cell.
* @return {ThreadedCommentCollection}
*/
getThreadedComments(cellName) {
}
/**
* Adds a comment to the collection.
* @param {Number} row - Cell row index.
* @param {Number} column - Cell column index.
* @return {Number} Comment object index.
*/
add(row, column) {
}
/**
* Adds a comment to the collection.
* @param {String} cellName - Cell name.
* @return {Number} Comment object index.
*/
add(cellName) {
}
/**
* Removes the comment of the specific cell.
* @param {String} cellName - The name of cell which contains a comment.
*/
removeAt(cellName) {
}
/**
* Removes the comment of the specific cell.
* @param {Number} row - The row index.
* @param {Number} column - the column index.
*/
removeAt(row, column) {
}
/**
* Removes all comments;
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the shape of the comment.
* @hideconstructor
*/
class CommentShape {
/**
* Gets the comment object.
*/
getComment() {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Encapsulates a collection of FormatCondition objects.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* //Get Conditional Formattings
* var cformattings = sheet.getConditionalFormattings();
* //Adds an empty conditional formatting
* var index = cformattings.add();
* //Get newly added Conditional formatting
* var fcs = cformattings.get(index);
* //Sets the conditional format range.
* var ca = new aspose.cells.CellArea();
* ca.StartRow = 0;
* ca.EndRow = 0;
* ca.StartColumn = 0;
* ca.EndColumn = 0;
* fcs.addArea(ca);
* ca = new aspose.cells.CellArea();
* ca.StartRow = 1;
* ca.EndRow = 1;
* ca.StartColumn = 1;
* ca.EndColumn = 1;
* fcs.addArea(ca);
* //Add condition.
* var conditionIndex = fcs.addCondition(aspose.cells.FormatConditionType.CELL_VALUE, aspose.cells.OperatorType.BETWEEN, "=A2", "100");
* //Add condition.
* var conditionIndex2 = fcs.addCondition(aspose.cells.FormatConditionType.CELL_VALUE, aspose.cells.OperatorType.BETWEEN, "50", "100");
* //Sets the background color.
* var fc = fcs.get(conditionIndex);
* fc.getStyle().setBackgroundColor(aspose.cells.Color.getRed());
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ConditionalFormattingCollection {
/**
*/
getCount() {
}
/**
* Gets the FormatConditions element at the specified index.
* @param {Number} index - The zero based index of the element.
*/
get(index) {
}
/**
* Remove all conditional formatting in the range.
* @param {Number} startRow - The start row of the range.
* @param {Number} startColumn - The start column of the range.
* @param {Number} totalRows - The number of rows of the range.
* @param {Number} totalColumns - The number of columns of the range.
*/
removeArea(startRow, startColumn, totalRows, totalColumns) {
}
/**
* Copies conditional formatting.
* @param {ConditionalFormattingCollection} cfs - The conditional formatting
*/
copy(cfs) {
}
/**
* Adds a FormatConditions to the collection.
* @return {Number} FormatConditions object index.
*/
add() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the custom icon of conditional formatting rule.
* @hideconstructor
*/
class ConditionalFormattingIcon {
/**
* Gets the icon set data.
*/
getImageData() {
}
/**
* Gets and sets the icon set type.
* The value of the property is IconSetType integer constant.
*/
getType() {
}
/**
* Gets and sets the icon set type.
* The value of the property is IconSetType integer constant.
*/
setType(value) {
}
/**
* Gets and sets the icon's index in the icon set.
*/
getIndex() {
}
/**
* Gets and sets the icon's index in the icon set.
*/
setIndex(value) {
}
/**
* Get the icon set data
* @param {Number} type - IconSetType
* @param {Number} index - icon's index
* @return {byte[]}
*/
static getIconImageData(type, index) {
}
/**
* Gets the image data with the setting of cell.
* @param {Cell} cell - The setting of cell.
* @return {byte[]} Returns the image data of icon.
*/
getImageData(cell) {
}
}
/**
* Represents a collection of ConditionalFormattingIcon objects.
* @hideconstructor
*/
class ConditionalFormattingIconCollection {
/**
*/
getCount() {
}
/**
* Gets the ConditionalFormattingIcon element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ConditionalFormattingIcon} The element at the specified index.
*/
get(index) {
}
/**
* Adds ConditionalFormattingIcon object.
* @param {Number} type - IconSetType
* @param {Number} index - The Index.
* @return {Number} Returns the index of new object in the list.
*/
add(type, index) {
}
/**
* Adds ConditionalFormattingIcon object.
* @param {ConditionalFormattingIcon} cficon - Returns the index of new object in the list.
*/
add(cficon) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the result of conditional formatting which applies to a cell.
* @hideconstructor
*/
class ConditionalFormattingResult {
/**
* Gets the conditional result style.
*/
getConditionalStyle() {
}
/**
* Gets the image of icon set.
*/
getConditionalFormattingIcon() {
}
/**
* Gets the DataBar object.
*/
getConditionalFormattingDataBar() {
}
/**
* Gets the ColorScale object.
*/
getConditionalFormattingColorScale() {
}
/**
* Gets the display color of color scale.
*/
getColorScaleResult() {
}
}
/**
* Describes the values of the interpolation points in a gradient scale, dataBar or iconSet.
* @hideconstructor
*/
class ConditionalFormattingValue {
/**
* Get or set the value of this conditional formatting value object.
* It should be used in conjunction with Type.
* 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() {
}
/**
* Get or set the value of this conditional formatting value object.
* It should be used in conjunction with Type.
* 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) {
}
/**
* 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.
* The value of the property is FormatConditionValueType integer constant.
*/
getType() {
}
/**
* 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.
* The value of the property is FormatConditionValueType integer constant.
*/
setType(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setGTE(value) {
}
}
/**
* Describes a collection of CFValueObject.
* Use only for icon sets.
* @hideconstructor
*/
class ConditionalFormattingValueCollection {
/**
*/
getCount() {
}
/**
* Get the CFValueObject element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ConditionalFormattingValue} The element at the specified index.
*/
get(index) {
}
/**
* Adds ConditionalFormattingValue object.
* @param {Number} type - FormatConditionValueType
* @param {String} value - The value.
* @return {Number} Returns the index of new object in the list.
*/
add(type, value) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Specifies properties about any parameters used with external data connections
* Parameters are valid for ODBC and web queries.
* @hideconstructor
*/
class ConnectionParameter {
/**
* SQL data type of the parameter. Only valid for ODBC sources.
* The value of the property is SqlDataType integer constant.
*/
getSqlType() {
}
/**
* SQL data type of the parameter. Only valid for ODBC sources.
* The value of the property is SqlDataType integer constant.
*/
setSqlType(value) {
}
/**
* 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() {
}
/**
* 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).
*/
setRefreshOnChange(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setPrompt(value) {
}
/**
* 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() {
}
/**
* The name of the parameter.
*/
getName() {
}
/**
* The name of the parameter.
*/
setName(value) {
}
/**
* Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.
*/
getCellReference() {
}
/**
* Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.
*/
setCellReference(value) {
}
/**
* Non-integer numeric value,Integer value,String value or Boolean value
* to use as the query parameter. Used only when parameterType is value.
*/
getValue() {
}
/**
* Non-integer numeric value,Integer value,String value or Boolean value
* to use as the query parameter. Used only when parameterType is value.
*/
setValue(value) {
}
}
/**
* Specifies the ConnectionParameter collection
* @hideconstructor
*/
class ConnectionParameterCollection {
/**
*/
getCount() {
}
/**
* Gets the ConnectionParameter element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ConnectionParameter} The element at the specified index.
*/
get(index) {
}
/**
* Gets the ConnectionParameter element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ConnectionParameter} The element at the specified index.
*/
set(index, value) {
}
/**
* Gets the ConnectionParameter element with the specified name.
* @param {String} connParamName - connection parameter name
* @return {ConnectionParameter} The element with the specified name.
*/
get(connParamName) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents identifier information.
* @hideconstructor
*/
class ContentTypeProperty {
/**
* Returns or sets the name of the object.
*/
getName() {
}
/**
* Returns or sets the name of the object.
*/
setName(value) {
}
/**
* Returns or sets the value of the content type property.
*/
getValue() {
}
/**
* Returns or sets the value of the content type property.
*/
setValue(value) {
}
/**
* Gets and sets the type of the property.
*/
getType() {
}
/**
* Gets and sets the type of the property.
*/
setType(value) {
}
/**
* Indicates whether the value could be empty.
*/
isNillable() {
}
/**
* Indicates whether the value could be empty.
*/
setNillable(value) {
}
}
/**
* A collection of ContentTypeProperty objects that represent additional information.
* @hideconstructor
*/
class ContentTypePropertyCollection {
/**
*/
getCount() {
}
/**
* Gets the content type property by the specific index.
* @param {Number} index - The index.
* @return {ContentTypeProperty} The content type property
*/
get(index) {
}
/**
* Gets the content type property by the property name.
* @param {String} name - The property name.
* @return {ContentTypeProperty} The content type property
*/
get(name) {
}
/**
* Adds content type property information.
* @param {String} name - The name of the content type property.
* @param {String} value - The value of the content type property.
*/
add(name, value) {
}
/**
* Adds content type property information.
* @param {String} name - The name of the content type property.
* @param {String} value - The value of the content type property.
* @param {String} type - The type of the content type property.
*/
add(name, value, type) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the copy options.
*/
class CopyOptions {
/**
* CopyOptions constructor.
*/
constructor() {
}
/**
* Indicates whether keeping macros;
* Only for copying workbook.
*/
getKeepMacros() {
}
/**
* Indicates whether keeping macros;
* Only for copying workbook.
*/
setKeepMacros(value) {
}
/**
* Indicates whether extend ranges when copying the range to adjacent range.
* If it's true, only extends the range of the hyperlink,not adding a new hyperlink when copying hyperlinks to adjacent rows.
*/
getExtendToAdjacentRange() {
}
/**
* Indicates whether extend ranges when copying the range to adjacent range.
* If it's true, only extends the range of the hyperlink,not adding a new hyperlink when copying hyperlinks to adjacent rows.
*/
setExtendToAdjacentRange(value) {
}
/**
* Indicates whether copying the names.
*/
getCopyNames() {
}
/**
* Indicates whether copying the names.
*/
setCopyNames(value) {
}
/**
* If the formula is not valid for the dest destination, only copy values.
*/
getCopyInvalidFormulasAsValues() {
}
/**
* If the formula is not valid for the dest destination, only copy values.
*/
setCopyInvalidFormulasAsValues(value) {
}
/**
* Indicates whether copying column width in unit of characters.
*/
getColumnCharacterWidth() {
}
/**
* Indicates whether copying column width in unit of characters.
*/
setColumnCharacterWidth(value) {
}
/**
* In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one,
* the copied formulas should refer to source workbook.
* However, for some situations user may need the copied formulas refer to worksheets with the same name
* in the same workbook, such as when those worksheets have been copied before this copy operation,
* then this property should be kept as true.
* The default value is true.
*/
getReferToSheetWithSameName() {
}
/**
* In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one,
* the copied formulas should refer to source workbook.
* However, for some situations user may need the copied formulas refer to worksheets with the same name
* in the same workbook, such as when those worksheets have been copied before this copy operation,
* then this property should be kept as true.
* The default value is true.
*/
setReferToSheetWithSameName(value) {
}
/**
* When copying the range in the same file and the chart refers to the source sheet,
* False means the copied chart's data source will not be changed.
* True means the copied chart's data source refers to the destination sheet.
* The default value is false, it works as MS Excel.
*/
getReferToDestinationSheet() {
}
/**
* When copying the range in the same file and the chart refers to the source sheet,
* False means the copied chart's data source will not be changed.
* True means the copied chart's data source refers to the destination sheet.
* The default value is false, it works as MS Excel.
*/
setReferToDestinationSheet(value) {
}
}
/**
* A collection of custom document properties.
* Each DocumentProperty object represents a custom property of a container document.
* @example
* //Instantiate a Workbook object
* var workbook = new aspose.cells.Workbook("Book1.xls");
* //Retrieve a list of all custom document properties of the Excel file
* var customProperties = workbook.getWorksheets().getCustomDocumentProperties();
* @hideconstructor
*/
class CustomDocumentPropertyCollection {
/**
*/
getCount() {
}
/**
* Returns a DocumentProperty object by the name of the property.
* Returns null if a property with the specified name is not found.
* @param {String} name - The case-insensitive name of the property to retrieve.
*/
get(name) {
}
/**
* Returns a DocumentProperty object by index.
* @param {Number} index - Zero-based index of the
*/
get(index) {
}
/**
* Creates a new custom document property of the PropertyType.String data type.
* @param {String} name - The name of the property.
* @param {String} value - The value of the property.
* @return {DocumentProperty} The newly created property object.
*/
add(name, value) {
}
/**
* Creates a new custom document property of the PropertyType.Number data type.
* @param {String} name - The name of the property.
* @param {Number} value - The value of the property.
* @return {DocumentProperty} The newly created property object.
*/
add(name, value) {
}
/**
* Creates a new custom document property of the PropertyType.DateTime data type.
* @param {String} name - The name of the property.
* @param {DateTime} value - The value of the property.
* @return {DocumentProperty} The newly created property object.
*/
add(name, value) {
}
/**
* Creates a new custom document property of the PropertyType.Boolean data type.
* @param {String} name - The name of the property.
* @param {boolean} value - The value of the property.
* @return {DocumentProperty} The newly created property object.
*/
add(name, value) {
}
/**
* Creates a new custom document property of the PropertyType.Float data type.
* @param {String} name - The name of the property.
* @param {Number} value - The value of the property.
* @return {DocumentProperty} The newly created property object.
*/
add(name, value) {
}
/**
* Creates a new custom document property which links to content.
* @param {String} name - The name of the property.
* @param {String} source - The source of the property
* @return {DocumentProperty} The newly created property object.
*/
addLinkToContent(name, source) {
}
/**
* Update custom document property value which links to content.
*/
updateLinkedPropertyValue() {
}
/**
* Update custom document property value to linked range.
*/
updateLinkedRange() {
}
/**
* Returns true if a property with the specified name exists in the collection.
* @param {String} name - The case-insensitive name of the property.
* @return {boolean} True if the property exists in the collection; false otherwise.
*/
contains(name) {
}
/**
* Gets the index of a property by name.
* @param {String} name - The case-insensitive name of the property.
* @return {Number} The zero based index. Negative value if not found.
*/
indexOf(name) {
}
/**
* Removes a property with the specified name from the collection.
* @param {String} name - The case-insensitive name of the property.
*/
remove(name) {
}
/**
* Removes a property at the specified index.
* @param {Number} index - The zero based index.
*/
removeAt(index) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the custom filter.
* @hideconstructor
*/
class CustomFilter {
/**
* Gets and sets the filter operator type.
* The value of the property is FilterOperatorType integer constant.
*/
getFilterOperatorType() {
}
/**
* Gets and sets the filter operator type.
* The value of the property is FilterOperatorType integer constant.
*/
setFilterOperatorType(value) {
}
/**
* Gets and sets the criteria.
*/
getCriteria() {
}
/**
* Gets and sets the criteria.
*/
setCriteria(value) {
}
/**
* Sets the filter criteria.
* @param {Number} filterOperator - FilterOperatorType
* @param {Object} criteria - filter criteria value
*/
setCriteria(filterOperator, criteria) {
}
}
/**
* Represents the custom filters.
*/
class CustomFilterCollection {
/**
* Constructs new instance.
*/
constructor() {
}
/**
* Indicates whether the two criteria have an "and" relationship.
*/
getAnd() {
}
/**
* Indicates whether the two criteria have an "and" relationship.
*/
setAnd(value) {
}
/**
*/
getCount() {
}
/**
* Gets the custom filter in the specific index.
* @param {Number} index - The index.
* @return {CustomFilter}
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Definition of custom function for calculating with user's custom engine.
*/
class CustomFunctionDefinition {
/**
*/
constructor() {
}
/**
* Gets the indices of given custom function's parameters that need to be calculated in array mode.
* 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.
* @param {String} functionName - Name of the custom function.
* @return {Number[]} 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.
*/
getArrayModeParameters(functionName) {
}
}
/**
* Represents a custom geometric shape.
* @hideconstructor
*/
class CustomGeometry {
/**
* Gets path collection information when shape is a NotPrimitive autoshape
*/
getPaths() {
}
/**
* Gets a collection of shape adjust value
*/
getShapeAdjustValues() {
}
}
/**
* Represents an item of custom grouped field.
*/
class CustomPiovtFieldGroupItem {
/**
* The constructor of custom group item of pivot field.
* @param {String} name - The name of group item
* @param {Number[]} itemIndexes - All indexes to the items of base pivot field.
*/
constructor(name, itemIndexes) {
}
}
/**
* Represents identifier information.
*/
class CustomProperty {
/**
*/
constructor() {
}
/**
* Returns or sets the name of the object.
*/
getName() {
}
/**
* Returns or sets the name of the object.
*/
setName(value) {
}
/**
* Returns or sets the value of the custom property.
* NOTE: This member is now obsolete. Instead,
* please use CustomProperty.Value property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStringValue() {
}
/**
* Returns or sets the value of the custom property.
* NOTE: This member is now obsolete. Instead,
* please use CustomProperty.Value property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStringValue(value) {
}
/**
* Returns or sets the value of the custom property.
*/
getValue() {
}
/**
* Returns or sets the value of the custom property.
*/
setValue(value) {
}
}
/**
* A collection of CustomProperty objects that represent additional information.
* @hideconstructor
*/
class CustomPropertyCollection {
/**
*/
getCount() {
}
/**
* Gets the custom property by the specific index.
* @param {Number} index - The index.
* @return {CustomProperty} The custom property
*/
get(index) {
}
/**
* Gets the custom property by the property name.
* @param {String} name - The property name.
* @return {CustomProperty} The custom property
*/
get(name) {
}
/**
* Adds custom property information.
* @param {String} name - The name of the custom property.
* @param {String} value - The value of the custom property.
*/
add(name, value) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents Custom xml shape ,such as Ink.
* @hideconstructor
*/
class CustomXmlShape {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the ActiveX control.
*/
getActiveXControl() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Creates the shape image and saves it to a stream in the specified format.
* The following formats are supported:
* .bmp, .gif, .jpg, .jpeg, .tiff, .emf.
* @param {OutputStream} stream - The output stream.
* @param {ImageFormat} imageFormat - The format in which to save the image.
*/
toImage(stream, imageFormat) {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Saves the shape to a stream.
*/
toImage(stream, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Describe the DataBar conditional formatting rule.
* This conditional formatting rule displays a gradated
* data bar in the range of cells.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* //Adds an empty conditional formatting
* var index = sheet.getConditionalFormattings().add();
* var fcs = sheet.getConditionalFormattings().get(index);
* //Sets the conditional format range.
* var ca = new aspose.cells.CellArea();
* ca.StartRow = 0;
* ca.EndRow = 2;
* ca.StartColumn = 0;
* ca.EndColumn = 0;
* fcs.addArea(ca);
* //Adds condition.
* var idx = fcs.addCondition(aspose.cells.FormatConditionType.DATA_BAR);
* fcs.addArea(ca);
* var cond = fcs.get(idx);
* //Get Databar
* var dataBar = cond.getDataBar();
* dataBar.setColor(aspose.cells.Color.getOrange());
* //Set Databar properties
* dataBar.getMinCfvo().setType(aspose.cells.FormatConditionValueType.PERCENTILE);
* dataBar.getMinCfvo().setValue(30);
* dataBar.setShowValue(false);
* //Put Cell Values
* var cell1 = sheet.getCells().get("A1");
* cell1.putValue(10);
* var cell2 = sheet.getCells().get("A2");
* cell2.putValue(120);
* var cell3 = sheet.getCells().get("A3");
* cell3.putValue(260);
* //Saving the Excel file
* workbook.save("Book1.xlsx");
* @hideconstructor
*/
class DataBar {
/**
* Gets the color of the axis for cells with conditional formatting as data bars.
*/
getAxisColor() {
}
/**
* Gets the color of the axis for cells with conditional formatting as data bars.
*/
setAxisColor(value) {
}
/**
* Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.
* The value of the property is DataBarAxisPosition integer constant.
*/
getAxisPosition() {
}
/**
* Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.
* The value of the property is DataBarAxisPosition integer constant.
*/
setAxisPosition(value) {
}
/**
* Gets or sets how a data bar is filled with color.
* The value of the property is DataBarFillType integer constant.
*/
getBarFillType() {
}
/**
* Gets or sets how a data bar is filled with color.
* The value of the property is DataBarFillType integer constant.
*/
setBarFillType(value) {
}
/**
* Gets or sets the direction the databar is displayed.
* The value of the property is TextDirectionType integer constant.
*/
getDirection() {
}
/**
* Gets or sets the direction the databar is displayed.
* The value of the property is TextDirectionType integer constant.
*/
setDirection(value) {
}
/**
* Gets an object that specifies the border of a data bar.
*/
getBarBorder() {
}
/**
* Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.
*/
getNegativeBarFormat() {
}
/**
* Get or set this DataBar's min value object.
* Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
*/
getMinCfvo() {
}
/**
* Get or set this DataBar's max value object.
* Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
*/
getMaxCfvo() {
}
/**
* Get or set this DataBar's Color.
*/
getColor() {
}
/**
* Get or set this DataBar's Color.
*/
setColor(value) {
}
/**
* Represents the min length of data bar .
*/
getMinLength() {
}
/**
* Represents the min length of data bar .
*/
setMinLength(value) {
}
/**
* Represents the max length of data bar .
*/
getMaxLength() {
}
/**
* Represents the max length of data bar .
*/
setMaxLength(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setShowValue(value) {
}
/**
* Render data bar in cell to image byte array.
* @param {Cell} cell - Indicate the data bar in which cell to be rendered
* @param {ImageOrPrintOptions} imgOpts - ImageOrPrintOptions contains some property of output image
* @return {byte[]}
*/
toImage(cell, imgOpts) {
}
}
/**
* Represents the border of the data bars specified by a conditional formatting rule.
* @hideconstructor
*/
class DataBarBorder {
/**
* Gets or sets the border's color of data bars specified by a conditional formatting rule.
*/
getColor() {
}
/**
* Gets or sets the border's color of data bars specified by a conditional formatting rule.
*/
setColor(value) {
}
/**
* Gets or sets the border's type of data bars specified by a conditional formatting rule.
* The value of the property is DataBarBorderType integer constant.
*/
getType() {
}
/**
* Gets or sets the border's type of data bars specified by a conditional formatting rule.
* The value of the property is DataBarBorderType integer constant.
*/
setType(value) {
}
}
/**
* Encapsulates a collection of all the DataLabel objects for the specified Series.
* @example
* //Set the DataLabels in the chart
* var datalabels;
* for (var i = 0; i < chart.getNSeries().getCount(); i++)
* {
* datalabels = chart.getNSeries().get(i).getDataLabels();
* //Set the position of DataLabels
* datalabels.setPosition(aspose.cells.LabelPositionType.INSIDE_BASE);
* //Show the category name in the DataLabels
* datalabels.setCategoryNameShown(true);
* //Show the value in the DataLabels
* datalabels.setShowValue(true);
* //Not show the percentage in the DataLabels
* datalabels.setPercentageShown(false);
* //Not show the legend key.
* datalabels.setLegendKeyShown(false);
* }
* @hideconstructor
*/
class DataLabels {
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the Area.
*/
getArea() {
}
/**
* Indicates the text is auto generated.
*/
isAutoText() {
}
/**
* Indicates the text is auto generated.
*/
setAutoText(value) {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
getDirectionType() {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
setDirectionType(value) {
}
/**
* Gets or sets the text of data label.
*/
getText() {
}
/**
* Gets or sets the text of data label.
*/
setText(value) {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
isTextWrapped() {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Represents a specified chart's data label values display behavior. True displays the values. False to hide.
*/
getShowValue() {
}
/**
* Represents a specified chart's data label values display behavior. True displays the values. False to hide.
*/
setShowValue(value) {
}
/**
* Indicates whether showing cell range as the data labels.
*/
getShowCellRange() {
}
/**
* Indicates whether showing cell range as the data labels.
*/
setShowCellRange(value) {
}
/**
* Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
*/
getShowPercentage() {
}
/**
* Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
*/
setShowPercentage(value) {
}
/**
* Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
*/
getShowBubbleSize() {
}
/**
* Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
*/
setShowBubbleSize(value) {
}
/**
* Represents a specified chart's data label category name display behavior.True to display the category name for the data labels on a chart. False to hide.
*/
getShowCategoryName() {
}
/**
* Represents a specified chart's data label category name display behavior.True to display the category name for the data labels on a chart. False to hide.
*/
setShowCategoryName(value) {
}
/**
* Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
* True to show the series name. False to hide.
*/
getShowSeriesName() {
}
/**
* Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
* True to show the series name. False to hide.
*/
setShowSeriesName(value) {
}
/**
* Represents a specified chart's data label legend key display behavior.
* True if the data label legend key is visible.
*/
getShowLegendKey() {
}
/**
* Represents a specified chart's data label legend key display behavior.
* True if the data label legend key is visible.
*/
setShowLegendKey(value) {
}
/**
* Represents the format string for the DataLabels object.
*/
getNumberFormat() {
}
/**
* Represents the format string for the DataLabels object.
*/
setNumberFormat(value) {
}
/**
* Gets and sets the built-in number format.
*/
getNumber() {
}
/**
* Gets and sets the built-in number format.
*/
setNumber(value) {
}
/**
* True if the number format is linked to the cells
* (so that the number format changes in the labels when it changes in the cells).
*/
getNumberFormatLinked() {
}
/**
* True if the number format is linked to the cells
* (so that the number format changes in the labels when it changes in the cells).
*/
setNumberFormatLinked(value) {
}
/**
* Gets the font of the DataLabels;
*/
getFont() {
}
/**
* Gets or sets the separator type used for the data labels on a chart.
* The value of the property is DataLabelsSeparatorType integer constant.
* To set custom separator, please set the property SeparatorType as DataLabelsSeparatorType.CUSTOM and then specify the expected value for SeparatorValue.
*/
getSeparatorType() {
}
/**
* Gets or sets the separator type used for the data labels on a chart.
* The value of the property is DataLabelsSeparatorType integer constant.
* To set custom separator, please set the property SeparatorType as DataLabelsSeparatorType.CUSTOM and then specify the expected value for SeparatorValue.
*/
setSeparatorType(value) {
}
/**
* Gets or sets the separator value used for the data labels on a chart.
*/
getSeparatorValue() {
}
/**
* Gets or sets the separator value used for the data labels on a chart.
*/
setSeparatorValue(value) {
}
/**
* Represents the position of the data label.
* The value of the property is LabelPositionType integer constant.
*/
getPosition() {
}
/**
* Represents the position of the data label.
* The value of the property is LabelPositionType integer constant.
*/
setPosition(value) {
}
/**
* Indicates whether the datalabels display never overlap. (For Pie chart)
*/
isNeverOverlap() {
}
/**
* Indicates whether the datalabels display never overlap. (For Pie chart)
*/
setNeverOverlap(value) {
}
/**
* Gets or sets shape type of data label.
* The value of the property is DataLabelShapeType integer constant.
*/
getShapeType() {
}
/**
* Gets or sets shape type of data label.
* The value of the property is DataLabelShapeType integer constant.
*/
setShapeType(value) {
}
/**
* Indicates whether this data labels is deleted.
*/
isDeleted() {
}
/**
* Indicates whether this data labels is deleted.
*/
setDeleted(value) {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
getRotationAngle() {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
setRotationAngle(value) {
}
/**
* Indicates whether the text of the chart is automatically rotated.
*/
isAutomaticRotation() {
}
/**
* Gets and sets a reference to the worksheet.
*/
getLinkedSource() {
}
/**
* Gets and sets a reference to the worksheet.
*/
setLinkedSource(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextDirection() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTextDirection(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
getReadingOrder() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
setReadingOrder(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setResizeShapeToFitText(value) {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
getX() {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
setX(value) {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getY() {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setY(value) {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getHeight() {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setHeight(value) {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
getWidth() {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
setWidth(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Set position of the frame to automatic
*/
setPositionAuto() {
}
}
/**
* Represents mashup data.
* @hideconstructor
*/
class DataMashup {
/**
* Gets all power query formulas.
*/
getPowerQueryFormulas() {
}
/**
* Gets all parameters of power query formulas.
*/
getPowerQueryFormulaParameters() {
}
}
/**
* Specifies a data model connection
* @hideconstructor
*/
class DataModelConnection {
/**
* Gets the id of the connection.
*/
getId() {
}
/**
* Gets the definition of power query formula.
*/
getPowerQueryFormula() {
}
/**
* Gets or Sets the external connection DataSource type.
*/
getType() {
}
/**
* 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() {
}
/**
* 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.
*/
setSourceFile(value) {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
getSSOId() {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
setSSOId(value) {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
getSavePassword() {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
setSavePassword(value) {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
getSaveData() {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
setSaveData(value) {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
getRefreshOnLoad() {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
setRefreshOnLoad(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
getReconnectionMethodType() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
setReconnectionMethodType(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getReconnectionMethod() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setReconnectionMethod(value) {
}
/**
* 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() {
}
/**
* 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
*/
setOnlyUseConnectionFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOdcFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setNew(value) {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
getName() {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
setName(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setKeepAlive(value) {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
getRefreshInternal() {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
setRefreshInternal(value) {
}
/**
* Specifies The unique identifier of this connection.
*/
getConnectionId() {
}
/**
* Specifies the user description for this connection
*/
getConnectionDescription() {
}
/**
* Specifies the user description for this connection
*/
setConnectionDescription(value) {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
isDeleted() {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
setDeleted(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
getCredentialsMethodType() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
setCredentialsMethodType(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getCredentials() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCredentials(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setBackgroundRefresh(value) {
}
/**
* Gets ConnectionParameterCollection for an ODBC or web query.
*/
getParameters() {
}
}
/**
* Summary description for DataSorter.
* @example
* //Instantiate a new Workbook object.
* var workbook = new aspose.cells.Workbook("Book1.xls");
* //Get the workbook datasorter object.
* var sorter = workbook.getDataSorter();
* //Set the first order for datasorter object.
* sorter.setOrder1(aspose.cells.SortOrder.DESCENDING);
* //Define the first key.
* sorter.setKey1(0);
* //Set the second order for datasorter object.
* sorter.setOrder2(aspose.cells.SortOrder.ASCENDING);
* //Define the second key.
* sorter.setKey2(1);
* //Create a cells area (range).
* var ca = new aspose.cells.CellArea();
* //Specify the start row index.
* ca.StartRow = 0;
* //Specify the start column index.
* ca.StartColumn = 0;
* //Specify the last row index.
* ca.EndRow = 13;
* //Specify the last column index.
* ca.EndColumn = 1;
* //Sort data in the specified data range (A1:B14)
* sorter.sort(workbook.getWorksheets().get(0).getCells(), ca);
* //Save the excel file.
* workbook.save("Book2.xls");
* @hideconstructor
*/
class DataSorter {
/**
* Gets the key list of data sorter.
*/
getKeys() {
}
/**
* Represents whether the range has headers.
*/
hasHeaders() {
}
/**
* Represents whether the range has headers.
*/
setHasHeaders(value) {
}
/**
* Represents first sorted column index(absolute position, column A is 0, B is 1, ...).
*/
getKey1() {
}
/**
* Represents first sorted column index(absolute position, column A is 0, B is 1, ...).
*/
setKey1(value) {
}
/**
* Represents sort order of the first key.
* The value of the property is SortOrder integer constant.
*/
getOrder1() {
}
/**
* Represents sort order of the first key.
* The value of the property is SortOrder integer constant.
*/
setOrder1(value) {
}
/**
* Represents second sorted column index(absolute position, column A is 0, B is 1, ...).
*/
getKey2() {
}
/**
* Represents second sorted column index(absolute position, column A is 0, B is 1, ...).
*/
setKey2(value) {
}
/**
* Represents sort order of the second key.
* The value of the property is SortOrder integer constant.
*/
getOrder2() {
}
/**
* Represents sort order of the second key.
* The value of the property is SortOrder integer constant.
*/
setOrder2(value) {
}
/**
* Represents third sorted column index(absolute position, column A is 0, B is 1, ...).
*/
getKey3() {
}
/**
* Represents third sorted column index(absolute position, column A is 0, B is 1, ...).
*/
setKey3(value) {
}
/**
* Represents sort order of the third key.
* The value of the property is SortOrder integer constant.
*/
getOrder3() {
}
/**
* Represents sort order of the third key.
* The value of the property is SortOrder integer constant.
*/
setOrder3(value) {
}
/**
* True means that sorting orientation is from left to right.
* False means that sorting orientation is from top to bottom.
* The default value is false.
*/
getSortLeftToRight() {
}
/**
* True means that sorting orientation is from left to right.
* False means that sorting orientation is from top to bottom.
* The default value is false.
*/
setSortLeftToRight(value) {
}
/**
* Gets and sets whether case sensitive when comparing string.
*/
getCaseSensitive() {
}
/**
* Gets and sets whether case sensitive when comparing string.
*/
setCaseSensitive(value) {
}
/**
* Indicates whether sorting anything that looks like a number.
*/
getSortAsNumber() {
}
/**
* Indicates whether sorting anything that looks like a number.
*/
setSortAsNumber(value) {
}
/**
* Clear all settings.
*/
clear() {
}
/**
* Adds sorted column index and sort order.
* @param {Number} key - The sorted column index(absolute position, column A is 0, B is 1, ...)
* @param {Number} order - SortOrder
*/
addKey(key, order) {
}
/**
* Adds sorted column index and sort order with custom sort list.
* @param {Number} key - The sorted column index(absolute position, column A is 0, B is 1, ...)
* @param {Number} order - SortOrder
* @param {String} customList - The custom sort list.
*/
addKey(key, order, customList) {
}
/**
* Adds sorted column index and sort order with custom sort list.
* If type is SortOnType.CellColor or SortOnType.FontColor, the customList is Color.
* @param {Number} key - The sorted column index(absolute position, column A is 0, B is 1, ...)
* @param {Number} type - SortOnType
* @param {Number} order - SortOrder
* @param {Object} customList - The custom sort list.
*/
addKey(key, type, order, customList) {
}
/**
* Adds sorted column index and sort order with custom sort list.
* @param {Number} key - The sorted column index(absolute position, column A is 0, B is 1, ...)
* @param {Number} order - SortOrder
* @param {String[]} customList - The custom sort list.
*/
addKey(key, order, customList) {
}
/**
* Sorts the data of the area.
* @param {Cells} cells - The cells contains the data area.
* @param {Number} startRow - The start row of the area.
* @param {Number} startColumn - The start column of the area.
* @param {Number} endRow - The end row of the area.
* @param {Number} endColumn - The end column of the area.
* @return {Number[]} the original indices(absolute position, for example, column A is 0, B is 1, ...) of the sorted rows/columns.
* If no rows/columns needs to be moved by this sorting operation, null will be returned.
*/
sort(cells, startRow, startColumn, endRow, endColumn) {
}
/**
* Sort the data of the area.
* @param {Cells} cells - The cells contains the data area.
* @param {CellArea} area - The area needed to sort
* @return {Number[]} the original indices(absolute position, for example, column A is 0, B is 1, ...) of the sorted rows/columns.
* If no rows/columns needs to be moved by this sorting operation, null will be returned.
*/
sort(cells, area) {
}
/**
* Sort the data in the range.
* @return {Number[]} the original indices(absolute position, for example, column A is 0, B is 1, ...) of the sorted rows/columns.
* If no rows/columns needs to be moved by this sorting operation, null will be returned.
*/
sort() {
}
}
/**
* Represents the key of the data sorter.
* @hideconstructor
*/
class DataSorterKey {
/**
* Indicates the order of sorting.
* The value of the property is SortOrder integer constant.
*/
getOrder() {
}
/**
* Gets the sorted column index(absolute position, column A is 0, B is 1, ...).
*/
getIndex() {
}
/**
* Represents the type of sorting.
* The value of the property is SortOnType integer constant.
*/
getType() {
}
/**
* Represents the icon set type.
* The value of the property is IconSetType integer constant.
* Only takes effect when Type is SortOnType.ICON.
*/
getIconSetType() {
}
/**
* Represents the id of the icon set type.
* Only takes effect when Type is SortOnType.ICON.
*/
getIconId() {
}
/**
* Gets the sorted color.
* Only takes effect when Type is SortOnType.CELL_COLOR or SortOnType.FONT_COLOR.
*/
getColor() {
}
}
/**
* Represents the key list of data sorter.
*/
class DataSorterKeyCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets and sets DataSorterKey by index.
* @param {Number} index - The index.
* @return {DataSorterKey}
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents an instant in time, typically expressed as a date and time of day.
*/
class DateTime {
/**
* Initializes a new instance of the DateTime object to the specified year, month, and day.
* @param {Number} year - The year (1 through 9999).
* @param {Number} month - The month (1 through 12).
* @param {Number} day - The day (1 through the number of days in month).
*/
constructor(year, month, day) {
}
/**
* Initializes a new instance of the DateTime object to the specified year, month, day, hour, minute, and second.
* @param {Number} year - The year (1 through 9999).
* @param {Number} month - The month (1 through 12).
* @param {Number} day - The day (1 through the number of days in month).
* @param {Number} hour - The hours (0 through 23).
* @param {Number} minute - The minutes (0 through 59).
* @param {Number} second - The seconds (0 through 59).
*/
constructor_overload$1(year, month, day, hour, minute, second) {
}
/**
* Initializes a new instance of the DateTime object to the specified year, month, day, hour, minute, second, and millisecond.
* @param {Number} year - The year (1 through 9999).
* @param {Number} month - The month (1 through 12).
* @param {Number} day - The day (1 through the number of days in month).
* @param {Number} hour - The hours (0 through 23).
* @param {Number} minute - The minutes (0 through 59).
* @param {Number} second - The seconds (0 through 59).
* @param {Number} millisecond - The milliseconds (0 through 999).
*/
constructor_overload$2(year, month, day, hour, minute, second, millisecond) {
}
/**
* Initializes a new instance of the DateTime object to the specified Date object
* @param {Date} date - The Date object
*/
constructor_overload$3(date) {
}
/**
* Initializes a new instance of the DateTime object to the specified Calendar object
* @param {Calendar} cld - The Calendar object
*/
constructor_overload$4(cld) {
}
/**
* Converts the value of the current DateTime object to Date object.
* @return {Date} Date object
*/
toDate() {
}
/**
* Converts the value of the current DateTime object to Calendar object.
* @return {Calendar} Calendar object
*/
toCalendar() {
}
/**
* Converts the value of the current DateTime object to Coordinated Universal Time(UTC).
* @return {DateTime} A DateTime object of UTC
*/
toUniversalTime() {
}
/**
* Converts the value of the current DateTime object to local time.
* @return {DateTime} A DateTime object of local
*/
toLocalTime() {
}
/**
* Adds the specified number of days to the value of this instance.
* @param {Number} value - A number of whole and fractional days. The value parameter can be negative or positive.
* @return {DateTime} A DateTime object whose value is the sum of the date and time represented by this instance and the number of days represented by value.
*/
addDays(value) {
}
/**
* Adds the specified number of hours to the value of this instance.
* @param {Number} value - A number of whole and fractional hours. The value parameter can be negative or positive.
* @return {DateTime} A DateTime object whose value is the sum of the date and time represented by this instance and the number of hours represented by value.
*/
addHours(value) {
}
/**
* Adds the specified number of milliseconds to the value of this instance.
* @param {Number} value - A number of whole and fractional milliseconds. The value parameter can be negative or positive. Note that this value is rounded to the nearest integer.
* @return {DateTime} A DateTime object whose value is the sum of the date and time represented by this instance and the number of milliseconds represented by value.
*/
addMilliseconds(value) {
}
/**
* Adds the specified number of minutes to the value of this instance.
* @param {Number} value - A number of whole and fractional minutes. The value parameter can be negative or positive.
* @return {DateTime} A DateTime object whose value is the sum of the date and time represented by this instance and the number of minutes represented by value.
*/
addMinutes(value) {
}
/**
* Adds the specified number of months to the value of this instance.
* @param {Number} months - A number of months. The months parameter can be negative or positive.
* @return {DateTime} A DateTime object whose value is the sum of the date and time represented by this instance and months.
*/
addMonths(months) {
}
/**
* Adds the specified number of seconds to the value of this instance.
* @param {Number} value - A number of whole and fractional seconds. The value parameter can be negative or positive.
* @return {DateTime} A DateTime object whose value is the sum of the date and time represented by this instance and the number of seconds represented by value.
*/
addSeconds(value) {
}
/**
* Adds the specified number of years to the value of this instance.
* @param {Number} value - A number of years. The value parameter can be negative or positive.
* @return {DateTime} A DateTime object whose value is the sum of the date and time represented by this instance and the number of years represented by value.
*/
addYears(value) {
}
/**
* Compares the value of this instance to a specified object that contains a
* specified DateTime value, and returns an integer that indicates whether
* this instance is earlier than, the same as, or later than the specified DateTime value.
* @param {Object} value - A boxed DateTime object to compare, or null.
* @return {Number} A signed number indicating the relative values of this instance and value.
* Value Description Less than zero This instance is earlier than value. Zero
* This instance is the same as value. Greater than zero This instance is later
* than value, or value is null.
*/
compareTo(value) {
}
/**
* Compares the value of this instance to a specified DateTime value
* and returns an integer that indicates whether this instance is earlier than,
* the same as, or later than the specified DateTime value.
* @param {DateTime} value - A DateTime object to compare.
* @return {Number} A signed number indicating the relative values of this instance and the value
* parameter. Value Description Less than zero This instance is earlier than
* value. Zero This instance is the same as value. Greater than zero This instance
* is later than value.
*/
compareTo(value) {
}
/**
* Returns the hash code for this instance.
* @return {Number} A 32-bit signed integer hash code.
*/
hashCode() {
}
/**
* Returns a value indicating whether this instance is equal to a specified object.
* @param {Object} value - An object to compare to this instance.
* @return {boolean} true if value is an instance of DateTime and equals the value of this instance; otherwise, false.
*/
equals(value) {
}
/**
* Gets the day of the month represented by this instance.
* @return {Number} The day component, expressed as a value between 1 and 31.
*/
getDay() {
}
/**
* Gets the day of the week represented by this instance.
* @return {Number} the day of the week of this DateTime value.
*/
getDayOfWeek() {
}
/**
* Gets the day of the year represented by this instance.
* @return {Number} The day of the year, expressed as a value between 1 and 366.
*/
getDayOfYear() {
}
/**
* Gets the hour component of the date represented by this instance.
* @return {Number} The hour component, expressed as a value between 0 and 23.
*/
getHour() {
}
/**
* Gets the milliseconds component of the date represented by this instance.
* @return {Number} The milliseconds component, expressed as a value between 0 and 999.
*/
getMillisecond() {
}
/**
* Gets the minute component of the date represented by this instance.
* @return {Number} The minute component, expressed as a value between 0 and 59.
*/
getMinute() {
}
/**
* Gets the month component of the date represented by this instance.
* @return {Number} The month component, expressed as a value between 1 and 12.
*/
getMonth() {
}
/**
* Gets a DateTime object that is set to the current date and time on this computer, expressed as the local time.
* @return {DateTime} A DateTime object whose value is the current local date and time.
*/
static getNow() {
}
/**
* Gets the seconds component of the date represented by this instance.
* @return {Number} The seconds, between 0 and 59.
*/
getSecond() {
}
/**
* Gets the year component of the date represented by this instance.
* @return {Number} The year, between 1 and 9999.
*/
getYear() {
}
/**
* Converts the value of the current DateTime object to its equivalent string representation.
* @return {String} A string representation of the value of the current DateTime object.
*/
toString() {
}
}
/**
* Represents the datetime's group setting.
*/
class DateTimeGroupItem {
/**
* @param {Number} type - DateTimeGroupingType
* @param {Number} year
* @param {Number} month
* @param {Number} day
* @param {Number} hour
* @param {Number} minute
* @param {Number} second
*/
constructor(type, year, month, day, hour, minute, second) {
}
/**
* Gets the min value.
*/
getMinValue() {
}
/**
* Gets and sets the group type.
* The value of the property is DateTimeGroupingType integer constant.
*/
getDateTimeGroupingType() {
}
/**
* Gets and sets the group type.
* The value of the property is DateTimeGroupingType integer constant.
*/
setDateTimeGroupingType(value) {
}
/**
* Gets and sets the year of the grouped date time.
*/
getYear() {
}
/**
* Gets and sets the year of the grouped date time.
*/
setYear(value) {
}
/**
* Gets and sets the month of the grouped date time.
*/
getMonth() {
}
/**
* Gets and sets the month of the grouped date time.
*/
setMonth(value) {
}
/**
* Gets and sets the day of the grouped date time.
*/
getDay() {
}
/**
* Gets and sets the day of the grouped date time.
*/
setDay(value) {
}
/**
* Gets and sets the hour of the grouped date time.
*/
getHour() {
}
/**
* Gets and sets the hour of the grouped date time.
*/
setHour(value) {
}
/**
* Gets and sets the minute of the grouped date time.
*/
getMinute() {
}
/**
* Gets and sets the minute of the grouped date time.
*/
setMinute(value) {
}
/**
* Gets and sets the second of the grouped date time.
*/
getSecond() {
}
/**
* Gets and sets the second of the grouped date time.
*/
setSecond(value) {
}
}
/**
* Specifies all properties associated with an ODBC or OLE DB external data connection.
* @hideconstructor
*/
class DBConnection {
/**
* The connection information string is used to make contact with an OLE DB or ODBC data source.
*/
getConnectionInfo() {
}
/**
* The connection information string is used to make contact with an OLE DB or ODBC data source.
*/
setConnectionInfo(value) {
}
/**
* Gets the definition of power query formula.
*/
getPowerQueryFormula() {
}
/**
* 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.
* The value of the property is OLEDBCommandType integer constant.
*/
getCommandType() {
}
/**
* 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.
* The value of the property is OLEDBCommandType integer constant.
*/
setCommandType(value) {
}
/**
* 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() {
}
/**
* 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
*/
setCommand(value) {
}
/**
* 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
*/
getSeverCommand() {
}
/**
* 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
*/
setSeverCommand(value) {
}
/**
* Gets the id of the connection.
*/
getId() {
}
/**
* Gets or Sets the external connection DataSource type.
*/
getType() {
}
/**
* 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() {
}
/**
* 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.
*/
setSourceFile(value) {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
getSSOId() {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
setSSOId(value) {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
getSavePassword() {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
setSavePassword(value) {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
getSaveData() {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
setSaveData(value) {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
getRefreshOnLoad() {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
setRefreshOnLoad(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
getReconnectionMethodType() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
setReconnectionMethodType(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getReconnectionMethod() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setReconnectionMethod(value) {
}
/**
* 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() {
}
/**
* 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
*/
setOnlyUseConnectionFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOdcFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setNew(value) {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
getName() {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
setName(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setKeepAlive(value) {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
getRefreshInternal() {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
setRefreshInternal(value) {
}
/**
* Specifies The unique identifier of this connection.
*/
getConnectionId() {
}
/**
* Specifies the user description for this connection
*/
getConnectionDescription() {
}
/**
* Specifies the user description for this connection
*/
setConnectionDescription(value) {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
isDeleted() {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
setDeleted(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
getCredentialsMethodType() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
setCredentialsMethodType(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getCredentials() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCredentials(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setBackgroundRefresh(value) {
}
/**
* Gets ConnectionParameterCollection for an ODBC or web query.
*/
getParameters() {
}
}
/**
* Settings for the default values of workbook's style properties.
* @hideconstructor
*/
class DefaultStyleSettings {
/**
* Gets/Sets the default font name for the workbook
*/
getFontName() {
}
/**
* Gets/Sets the default font name for the workbook
*/
setFontName(value) {
}
/**
* Gets/Sets the default standard font size for the workbook.
*/
getFontSize() {
}
/**
* Gets/Sets the default standard font size for the workbook.
*/
setFontSize(value) {
}
/**
* Gets/Sets the default value for horizontal alignment
* The value of the property is TextAlignmentType integer constant.
*/
getHorizontalAlignment() {
}
/**
* Gets/Sets the default value for horizontal alignment
* The value of the property is TextAlignmentType integer constant.
*/
setHorizontalAlignment(value) {
}
/**
* Gets/Sets the default value for vertical alignment
* The value of the property is TextAlignmentType integer constant.
*/
getVerticalAlignment() {
}
/**
* Gets/Sets the default value for vertical alignment
* The value of the property is TextAlignmentType integer constant.
*/
setVerticalAlignment(value) {
}
}
/**
* Represents the setting of deleting blank cells/rows/columns.
*/
class DeleteBlankOptions {
/**
*/
constructor() {
}
/**
* Whether one cell will be taken as blank when its value is empty string. Default value is true.
*/
getEmptyStringAsBlank() {
}
/**
* Whether one cell will be taken as blank when its value is empty string. Default value is true.
*/
setEmptyStringAsBlank(value) {
}
/**
* Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string. Default value is false.
* 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 Cell.Formula will be taken as blank and may be deleted
* because before calculation their calculated results are all null.
*/
getEmptyFormulaValueAsBlank() {
}
/**
* Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string. Default value is false.
* 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 Cell.Formula will be taken as blank and may be deleted
* because before calculation their calculated results are all null.
*/
setEmptyFormulaValueAsBlank(value) {
}
/**
* Indicates if update references in other worksheets.
*/
getUpdateReference() {
}
/**
* Indicates if update references in other worksheets.
*/
setUpdateReference(value) {
}
}
/**
* Represents the setting of deleting rows/columns.
*/
class DeleteOptions {
/**
*/
constructor() {
}
/**
* Indicates if update references in other worksheets.
*/
getUpdateReference() {
}
/**
* Indicates if update references in other worksheets.
*/
setUpdateReference(value) {
}
}
/**
* 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.
* @hideconstructor
*/
class DelimiterEquationNode {
/**
* Delimiter beginning character.
* 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() {
}
/**
* Delimiter beginning character.
* 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) {
}
/**
* Delimiter ending character.
* 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() {
}
/**
* Delimiter ending character.
* 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) {
}
/**
* 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() {
}
/**
* 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) {
}
/**
* Delimiter separator character.
* 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() {
}
/**
* Delimiter separator character.
* 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) {
}
/**
* Specifies the shape of delimiters in the delimiter object.
* The value of the property is EquationDelimiterShapeType integer constant.
*/
getDelimiterShape() {
}
/**
* Specifies the shape of delimiters in the delimiter object.
* The value of the property is EquationDelimiterShapeType integer constant.
*/
setDelimiterShape(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents the dialog box.
* @hideconstructor
*/
class DialogBox {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the ActiveX control.
*/
getActiveXControl() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Creates the shape image and saves it to a stream in the specified format.
* The following formats are supported:
* .bmp, .gif, .jpg, .jpeg, .tiff, .emf.
* @param {OutputStream} stream - The output stream.
* @param {ImageFormat} imageFormat - The format in which to save the image.
*/
toImage(stream, imageFormat) {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Saves the shape to a stream.
*/
toImage(stream, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents the options of saving dif file.
*/
class DifSaveOptions {
/**
* Creates the options for saving DIF file.
*/
constructor() {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Signature in file.
* @hideconstructor
*/
class DigitalSignature {
/**
* Certificate object that was used to sign the document.
*/
getCertificate() {
}
/**
* Certificate object that was used to sign the document.
*/
setCertificate(value) {
}
/**
* The purpose to signature.
*/
getComments() {
}
/**
* The purpose to signature.
*/
setComments(value) {
}
/**
* The time when the document was signed.
*/
getSignTime() {
}
/**
* The time when the document was signed.
*/
setSignTime(value) {
}
/**
* Specifies a GUID which can be cross-referenced with the GUID of the signature line stored in the document content.
* Default value is Empty (all zeroes) Guid.
* When set, it associates SignatureLine with corresponding DigitalSignature.
*/
getId() {
}
/**
* Specifies a GUID which can be cross-referenced with the GUID of the signature line stored in the document content.
* Default value is Empty (all zeroes) Guid.
* When set, it associates SignatureLine with corresponding DigitalSignature.
*/
setId(value) {
}
/**
* Specifies the text of actual signature in the digital signature.
* Default value is Empty.
*/
getText() {
}
/**
* Specifies the text of actual signature in the digital signature.
* Default value is Empty.
*/
setText(value) {
}
/**
* Specifies an image for the digital signature.
* Default value is null.
*/
getImage() {
}
/**
* Specifies an image for the digital signature.
* Default value is null.
*/
setImage(value) {
}
/**
* Specifies the class ID of the signature provider.
* Default value is Empty (all zeroes) Guid.
* The cryptographic service provider (CSP) is an independent software module that actually performs cryptography algorithms for authentication, encoding, and encryption.
* Microsoft Office reserves the value of {00000000-0000-0000-0000-000000000000} for its default signature provider,
* and {000CD6A4-0000-0000-C000-000000000046} for its East Asian signature provider.
* The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.
*/
getProviderId() {
}
/**
* Specifies the class ID of the signature provider.
* Default value is Empty (all zeroes) Guid.
* The cryptographic service provider (CSP) is an independent software module that actually performs cryptography algorithms for authentication, encoding, and encryption.
* Microsoft Office reserves the value of {00000000-0000-0000-0000-000000000000} for its default signature provider,
* and {000CD6A4-0000-0000-C000-000000000046} for its East Asian signature provider.
* The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.
*/
setProviderId(value) {
}
/**
* If this digital signature is valid and the document has not been tampered with,
* this value will be true.
*/
isValid() {
}
/**
* XAdES type.
* Default value is None(XAdES is off).
* The value of the property is XAdESType integer constant.
*/
getXAdESType() {
}
/**
* XAdES type.
* Default value is None(XAdES is off).
* The value of the property is XAdESType integer constant.
*/
setXAdESType(value) {
}
}
/**
* Provides a collection of digital signatures attached to a document.
*/
class DigitalSignatureCollection {
/**
* The constructor of DigitalSignatureCollection.
*/
constructor() {
}
/**
* Add one signature to DigitalSignatureCollection.
* @param {DigitalSignature} digitalSignature - Digital signature in collection.
*/
add(digitalSignature) {
}
/**
* Get the enumerator for DigitalSignatureCollection,
* this enumerator allows iteration over the collection
* @return {Iterator} The enumerator to iteration.
*/
iterator() {
}
}
/**
* Represents the display unit label.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Excel object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "A4" cell
* worksheet.getCells().get("A4").putValue(200);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a sample value to "B4" cell
* worksheet.getCells().get("B4").putValue(40);
* //Adding a sample value to "C1" cell as category data
* worksheet.getCells().get("C1").putValue("Q1");
* //Adding a sample value to "C2" cell as category data
* worksheet.getCells().get("C2").putValue("Q2");
* //Adding a sample value to "C3" cell as category data
* worksheet.getCells().get("C3").putValue("Y1");
* //Adding a sample value to "C4" cell as category data
* worksheet.getCells().get("C4").putValue("Y2");
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
* chart.getNSeries().add("A1:B4", true);
* //Setting the data source for the category data of NSeries
* chart.getNSeries().setCategoryData("C1:C4");
* //Setting the display unit of value(Y) axis.
* chart.getValueAxis().setDisplayUnit(aspose.cells.DisplayUnitType.HUNDREDS);
* var displayUnitLabel = chart.getValueAxis().getDisplayUnitLabel();
* //Setting the custom display unit label
* displayUnitLabel.setText("100");
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class DisplayUnitLabel {
/**
* Gets or sets the text of display unit label.
*/
getText() {
}
/**
* Gets or sets the text of display unit label.
*/
setText(value) {
}
/**
* Gets a Font object of the specified ChartFrame object.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Indicates the text is auto generated.
*/
isAutoText() {
}
/**
* Indicates the text is auto generated.
*/
setAutoText(value) {
}
/**
* Indicates whether this data labels is deleted.
*/
isDeleted() {
}
/**
* Indicates whether this data labels is deleted.
*/
setDeleted(value) {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
getRotationAngle() {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
setRotationAngle(value) {
}
/**
* Indicates whether the text of the chart is automatically rotated.
*/
isAutomaticRotation() {
}
/**
* Gets and sets a reference to the worksheet.
*/
getLinkedSource() {
}
/**
* Gets and sets a reference to the worksheet.
*/
setLinkedSource(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextDirection() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTextDirection(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
getReadingOrder() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
setReadingOrder(value) {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
getDirectionType() {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
setDirectionType(value) {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
isTextWrapped() {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
setTextWrapped(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setResizeShapeToFitText(value) {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the area.
*/
getArea() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
getX() {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
setX(value) {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getY() {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setY(value) {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getHeight() {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setHeight(value) {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
getWidth() {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
setWidth(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Set position of the frame to automatic
*/
setPositionAuto() {
}
}
/**
* Represents a custom or built-in document property.
* @example
* //Instantiate a Workbook object
* var workbook = new aspose.cells.Workbook("Book1.xls");
* //Retrieve a list of all custom document properties of the Excel file
* var customProperties = workbook.getWorksheets().getCustomDocumentProperties();
* //Accessng a custom document property by using the property index
* var customProperty1 = customProperties.get(3);
* //Accessng a custom document property by using the property name
* var customProperty2 = customProperties.get("Owner");
* @hideconstructor
*/
class DocumentProperty {
/**
* Returns the name of the property.
*/
getName() {
}
/**
* Gets or sets the value of the property.
*/
getValue() {
}
/**
* Gets or sets the value of the property.
*/
setValue(value) {
}
/**
* Indicates whether this property is linked to content
*/
isLinkedToContent() {
}
/**
* The linked content source.
*/
getSource() {
}
/**
* Gets the data type of the property.
* The value of the property is PropertyType integer constant.
*/
getType() {
}
/**
* Returns true if this property does not have a name in the OLE2 storage
* and a unique name was generated only for the public API.
*/
isGeneratedName() {
}
/**
* Returns the property value as a string.
* Converts a number property using Object.ToString(). Converts a boolean property
* into "Y" or "N". Converts a date property into a short date string.
*/
toString() {
}
/**
* Returns the property value as integer.
* Throws an exception if the property type is not PropertyType.Number.
*/
toInt() {
}
/**
* Returns the property value as double.
* Throws an exception if the property type is not PropertyType.Float.
*/
toDouble() {
}
/**
* Returns the property value as DateTime in local timezone.
* Throws an exception if the property type is not PropertyType.Date.
*/
toDateTime() {
}
/**
* Returns the property value as bool.
* Throws an exception if the property type is not PropertyType.Boolean.
*/
toBool() {
}
}
/**
* Base class for BuiltInDocumentPropertyCollection and CustomDocumentPropertyCollection collections.
* @example
* //Instantiate a Workbook object by calling its empty constructor
* var workbook = new aspose.cells.Workbook("Book1.xls");
* //Retrieve a list of all custom document properties of the Excel file
* var customProperties = workbook.getWorksheets().getCustomDocumentProperties();
* //Accessng a custom document property by using the property index
* var customProperty1 = customProperties.get(3);
* //Accessng a custom document property by using the property name
* var customProperty2 = customProperties.get("Owner");
* @hideconstructor
*/
class DocumentPropertyCollection {
/**
*/
getCount() {
}
/**
* Returns a DocumentProperty object by the name of the property.
* Returns null if a property with the specified name is not found.
* @param {String} name - The case-insensitive name of the property to retrieve.
*/
get(name) {
}
/**
* Returns a DocumentProperty object by index.
* @param {Number} index - Zero-based index of the
*/
get(index) {
}
/**
* Returns true if a property with the specified name exists in the collection.
* @param {String} name - The case-insensitive name of the property.
* @return {boolean} True if the property exists in the collection; false otherwise.
*/
contains(name) {
}
/**
* Gets the index of a property by name.
* @param {String} name - The case-insensitive name of the property.
* @return {Number} The zero based index. Negative value if not found.
*/
indexOf(name) {
}
/**
* Removes a property with the specified name from the collection.
* @param {String} name - The case-insensitive name of the property.
*/
remove(name) {
}
/**
* Removes a property at the specified index.
* @param {Number} index - The zero based index.
*/
removeAt(index) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents options of saving .docx file.
*/
class DocxSaveOptions {
/**
* Represents options of saving .docx file.
*/
constructor() {
}
/**
* Represents options of saving .docx file.
* @param {boolean} 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_overload$1(saveAsImage) {
}
/**
* 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() {
}
/**
* 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.
*/
setDefaultFont(value) {
}
/**
* 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.
* Default is true.
*/
getCheckWorkbookDefaultFont() {
}
/**
* 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.
* Default is true.
*/
setCheckWorkbookDefaultFont(value) {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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() {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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) {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
isFontSubstitutionCharGranularity() {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
setFontSubstitutionCharGranularity(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOnePagePerSheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAllColumnsInOnePagePerSheet(value) {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
getIgnoreError() {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
setIgnoreError(value) {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
getOutputBlankPageWhenNothingToPrint() {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
setOutputBlankPageWhenNothingToPrint(value) {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
getPageIndex() {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
setPageIndex(value) {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
getPageCount() {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
setPageCount(value) {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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() {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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) {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
getGridlineType() {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
setGridlineType(value) {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
getTextCrossType() {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
setTextCrossType(value) {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
getDefaultEditLanguage() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
setDefaultEditLanguage(value) {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
getSheetSet() {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
setSheetSet(value) {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
getDrawObjectEventHandler() {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
setDrawObjectEventHandler(value) {
}
/**
* Control/Indicate progress of page saving process.
*/
getPageSavingCallback() {
}
/**
* Control/Indicate progress of page saving process.
*/
setPageSavingCallback(value) {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
getEmfRenderSetting() {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
setEmfRenderSetting(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents the up/down bars in a chart.
* @hideconstructor
*/
class DropBars {
/**
* Gets the border Line.
*/
getBorder() {
}
/**
* Gets the Area.
*/
getArea() {
}
}
/**
* Represents the master differential formatting records.
* @hideconstructor
*/
class DxfCollection {
/**
*/
getCount() {
}
/**
* Gets the element at the specified index.
* @param {Number} index - The specified index.
* @return {Style}
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the dynamic filter.
* @hideconstructor
*/
class DynamicFilter {
/**
* Gets and sets the dynamic filter type.
* The value of the property is DynamicFilterType integer constant.
*/
getDynamicFilterType() {
}
/**
* Gets and sets the dynamic filter type.
* The value of the property is DynamicFilterType integer constant.
*/
setDynamicFilterType(value) {
}
/**
* Gets and sets the dynamic filter value.
*/
getValue() {
}
/**
* Gets and sets the dynamic filter value.
*/
setValue(value) {
}
/**
* Gets and sets the dynamic filter max value.
*/
getMaxValue() {
}
/**
* Gets and sets the dynamic filter max value.
*/
setMaxValue(value) {
}
}
/**
* Represents options when importing an ebook file.
*/
class EbookLoadOptions {
/**
* Creates an options of loading the ebook file.
*/
constructor() {
}
/**
* Creates an options of loading the ebook file.
* @param {Number} loadFormat - LoadFormat
*/
constructor_overload$1(loadFormat) {
}
/**
* The directory that the attached files will be saved to.
* NOTE: This member is now obsolete. Instead,
* please use HtmlLoadOptions.StreamProvider property.
* This property will be removed 12 months later since December 2014.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getAttachedFilesDirectory() {
}
/**
* The directory that the attached files will be saved to.
* NOTE: This member is now obsolete. Instead,
* please use HtmlLoadOptions.StreamProvider property.
* This property will be removed 12 months later since December 2014.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setAttachedFilesDirectory(value) {
}
/**
* Indicates whether importing formulas if the original html file contains formulas
*/
getLoadFormulas() {
}
/**
* Indicates whether importing formulas if the original html file contains formulas
*/
setLoadFormulas(value) {
}
/**
* Indicates whether support the layout of <div> tag when the html file contains it.
* The default value is false.
*/
getSupportDivTag() {
}
/**
* Indicates whether support the layout of <div> tag when the html file contains it.
* The default value is false.
*/
setSupportDivTag(value) {
}
/**
* Indicates whether delete redundant spaces when the text wraps lines using <br> tag.
* The default value is false.
*/
getDeleteRedundantSpaces() {
}
/**
* Indicates whether delete redundant spaces when the text wraps lines using <br> tag.
* The default value is false.
*/
setDeleteRedundantSpaces(value) {
}
/**
* Indicates whether auto-fit columns and rows. The default value is false.
*/
getAutoFitColsAndRows() {
}
/**
* Indicates whether auto-fit columns and rows. The default value is false.
*/
setAutoFitColsAndRows(value) {
}
/**
* if true, convert string to formula when string value starts with character '=',the default value is false.
* NOTE: This property is now obsolete.
* Instead, please use HtmlLoadOptions.HasFormula property.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getConvertFormulasData() {
}
/**
* if true, convert string to formula when string value starts with character '=',the default value is false.
* NOTE: This property is now obsolete.
* Instead, please use HtmlLoadOptions.HasFormula property.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setConvertFormulasData(value) {
}
/**
* Indicates whether the text is formula if it starts with "=".
*/
hasFormula() {
}
/**
* Indicates whether the text is formula if it starts with "=".
*/
setHasFormula(value) {
}
/**
* Gets or sets the StreamProviderImportHtmlFile for importing objects.
*/
getStreamProvider() {
}
/**
* Gets or sets the StreamProviderImportHtmlFile for importing objects.
*/
setStreamProvider(value) {
}
/**
* Gets the program id of creating the file.
* Only for MHT files.
*/
getProgId() {
}
/**
* Get the HtmlTableLoadOptionCollection instance
*/
getTableLoadOptions() {
}
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
getEncoding() {
}
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
setEncoding(value) {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
getLoadStyleStrategy() {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
setLoadStyleStrategy(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
getConvertNumericData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
setConvertNumericData(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
getConvertDateTimeData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
setConvertDateTimeData(value) {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
getKeepPrecision() {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
setKeepPrecision(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents the options for saving ebook file.
*/
class EbookSaveOptions {
/**
* Creates options for saving ebook file.
*/
constructor() {
}
/**
* Indicate whether exporting those not visible shapes
* The default values is false.
*/
getIgnoreInvisibleShapes() {
}
/**
* Indicate whether exporting those not visible shapes
* The default values is false.
*/
setIgnoreInvisibleShapes(value) {
}
/**
* The title of the html page.
* Only for saving to html stream.
*/
getPageTitle() {
}
/**
* The title of the html page.
* Only for saving to html stream.
*/
setPageTitle(value) {
}
/**
* The directory that the attached files will be saved to.
* Only for saving to html stream.
*/
getAttachedFilesDirectory() {
}
/**
* The directory that the attached files will be saved to.
* Only for saving to html stream.
*/
setAttachedFilesDirectory(value) {
}
/**
* Specify the Url prefix of attached files such as image in the html file.
* Only for saving to html stream.
*/
getAttachedFilesUrlPrefix() {
}
/**
* Specify the Url prefix of attached files such as image in the html file.
* Only for saving to html stream.
*/
setAttachedFilesUrlPrefix(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDefaultFontName(value) {
}
/**
* Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
*/
getWorksheetScalable() {
}
/**
* Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
*/
setWorksheetScalable(value) {
}
/**
* Indicates if exporting comments when saving file to html, the default value is false.
*/
isExportComments() {
}
/**
* Indicates if exporting comments when saving file to html, the default value is false.
*/
setExportComments(value) {
}
/**
* Represents type of exporting comments to html files.
* The value of the property is PrintCommentsType integer constant.
*/
getExportCommentsType() {
}
/**
* Represents type of exporting comments to html files.
* The value of the property is PrintCommentsType integer constant.
*/
setExportCommentsType(value) {
}
/**
* Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
*/
getDisableDownlevelRevealedComments() {
}
/**
* Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
*/
setDisableDownlevelRevealedComments(value) {
}
/**
* Indicates whether exporting image files to temp directory.
* Only for saving to html stream.
*/
isExpImageToTempDir() {
}
/**
* Indicates whether exporting image files to temp directory.
* Only for saving to html stream.
*/
setExpImageToTempDir(value) {
}
/**
* 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() {
}
/**
* Indicates whether using scalable unit to describe the image width
* when using scalable unit to describe the column width.
* The default value is true.
*/
setImageScalable(value) {
}
/**
* Indicates whether exporting column width in unit of scale to html.
* The default value is false.
*/
getWidthScalable() {
}
/**
* Indicates whether exporting column width in unit of scale to html.
* The default value is false.
*/
setWidthScalable(value) {
}
/**
* Indicates whether exporting the single tab when the file only has one worksheet.
* The default value is false.
*/
getExportSingleTab() {
}
/**
* Indicates whether exporting the single tab when the file only has one worksheet.
* The default value is false.
*/
setExportSingleTab(value) {
}
/**
* Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
* When this property is set to true image data is exported directly on the
* img elements and separate files are not created.
*/
getExportImagesAsBase64() {
}
/**
* Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
* When this property is set to true image data is exported directly on the
* img elements and separate files are not created.
*/
setExportImagesAsBase64(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportActiveWorksheetOnly(value) {
}
/**
* Indicates if only exporting the print area to html file. The default value is false.
*/
getExportPrintAreaOnly() {
}
/**
* Indicates if only exporting the print area to html file. The default value is false.
*/
setExportPrintAreaOnly(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportArea(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setParseHtmlTagInCell(value) {
}
/**
* 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.
* The value of the property is HtmlCrossType integer constant.
*/
getHtmlCrossStringType() {
}
/**
* 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.
* The value of the property is HtmlCrossType integer constant.
*/
setHtmlCrossStringType(value) {
}
/**
* 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"
* The value of the property is HtmlHiddenColDisplayType integer constant.
*/
getHiddenColDisplayType() {
}
/**
* 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"
* The value of the property is HtmlHiddenColDisplayType integer constant.
*/
setHiddenColDisplayType(value) {
}
/**
* 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"
* The value of the property is HtmlHiddenRowDisplayType integer constant.
*/
getHiddenRowDisplayType() {
}
/**
* 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"
* The value of the property is HtmlHiddenRowDisplayType integer constant.
*/
setHiddenRowDisplayType(value) {
}
/**
* If not set,use Encoding.UTF8 as default enconding type.
*/
getEncoding() {
}
/**
* If not set,use Encoding.UTF8 as default enconding type.
*/
setEncoding(value) {
}
/**
* Gets or sets the ExportObjectListener for exporting objects.
* NOTE: This property is now obsolete. Instead,
* please use HtmlSaveOptions.IStreamProvider property.
* This property will be removed 12 months later since August 2015.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getExportObjectListener() {
}
/**
* Gets or sets the ExportObjectListener for exporting objects.
* NOTE: This property is now obsolete. Instead,
* please use HtmlSaveOptions.IStreamProvider property.
* This property will be removed 12 months later since August 2015.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setExportObjectListener(value) {
}
/**
* Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
*/
getFilePathProvider() {
}
/**
* Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
*/
setFilePathProvider(value) {
}
/**
* Gets or sets the IStreamProvider for exporting objects.
*/
getStreamProvider() {
}
/**
* Gets or sets the IStreamProvider for exporting objects.
*/
setStreamProvider(value) {
}
/**
* Get the ImageOrPrintOptions object before exporting
*/
getImageOptions() {
}
/**
* Indicates whether save the html as single file.
* The default value is false.
* 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() {
}
/**
* Indicates whether save the html as single file.
* The default value is false.
* 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) {
}
/**
* Indicates whether showing all sheets when saving as a single html file.
* Only works when SaveAsSingleFile is True.
*/
getShowAllSheets() {
}
/**
* Indicates whether showing all sheets when saving as a single html file.
* Only works when SaveAsSingleFile is True.
*/
setShowAllSheets(value) {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
getExportPageHeaders() {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
setExportPageHeaders(value) {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
getExportPageFooters() {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
setExportPageFooters(value) {
}
/**
* Indicating if exporting the hidden worksheet content.The default value is true.
*/
getExportHiddenWorksheet() {
}
/**
* Indicating if exporting the hidden worksheet content.The default value is true.
*/
setExportHiddenWorksheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setPresentationPreference(value) {
}
/**
* Gets and sets the prefix of the css name,the default value is "".
*/
getCellCssPrefix() {
}
/**
* Gets and sets the prefix of the css name,the default value is "".
*/
setCellCssPrefix(value) {
}
/**
* 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() {
}
/**
* 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 "".
*/
setTableCssId(value) {
}
/**
* Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
* The default value is false.
*/
isFullPathLink() {
}
/**
* Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
* The default value is false.
*/
setFullPathLink(value) {
}
/**
* Indicating whether export the worksheet css separately.The default value is false.
*/
getExportWorksheetCSSSeparately() {
}
/**
* Indicating whether export the worksheet css separately.The default value is false.
*/
setExportWorksheetCSSSeparately(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportSimilarBorderStyle(value) {
}
/**
* 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.
*/
getMergeEmptyTdForcely() {
}
/**
* 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.
*/
setMergeEmptyTdForcely(value) {
}
/**
* The option to merge contiguous empty cells(empty td elements)
* The default value is MergeEmptyTdType.Default.
* The value of the property is MergeEmptyTdType integer constant.
*/
getMergeEmptyTdType() {
}
/**
* The option to merge contiguous empty cells(empty td elements)
* The default value is MergeEmptyTdType.Default.
* The value of the property is MergeEmptyTdType integer constant.
*/
setMergeEmptyTdType(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportCellCoordinate(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportExtraHeadings(value) {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* NOTE: This member is now obsolete. Instead,
* please use HtmlSaveOptions.ExportRowColumnHeadings property.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getExportHeadings() {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* NOTE: This member is now obsolete. Instead,
* please use HtmlSaveOptions.ExportRowColumnHeadings property.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setExportHeadings(value) {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* The default value is false.
*/
getExportRowColumnHeadings() {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* The default value is false.
*/
setExportRowColumnHeadings(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportFormula(value) {
}
/**
* Indicates whether adding tooltip text when the data can't be fully displayed.
* The default value is false.
*/
getAddTooltipText() {
}
/**
* Indicates whether adding tooltip text when the data can't be fully displayed.
* The default value is false.
*/
setAddTooltipText(value) {
}
/**
* Indicating whether exporting the gridlines.The default value is false.
*/
getExportGridLines() {
}
/**
* Indicating whether exporting the gridlines.The default value is false.
*/
setExportGridLines(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportBogusRowData(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExcludeUnusedStyles(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportDocumentProperties(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportWorksheetProperties(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportWorkbookProperties(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportFrameScriptsAndProperties(value) {
}
/**
* Indicating the rule of exporting html file data.The default value is All.
* The value of the property is HtmlExportDataOptions integer constant.
*/
getExportDataOptions() {
}
/**
* Indicating the rule of exporting html file data.The default value is All.
* The value of the property is HtmlExportDataOptions integer constant.
*/
setExportDataOptions(value) {
}
/**
* Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
* The value of the property is HtmlLinkTargetType integer constant.
*/
getLinkTargetType() {
}
/**
* Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
* The value of the property is HtmlLinkTargetType integer constant.
*/
setLinkTargetType(value) {
}
/**
* Indicating whether the output HTML is compatible with IE browser.
* The defalut value is false
*/
isIECompatible() {
}
/**
* Indicating whether the output HTML is compatible with IE browser.
* The defalut value is false
*/
setIECompatible(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setFormatDataIgnoreColumnWidth(value) {
}
/**
* Indicates whether to calculate formulas before saving html file.
* The default value is false.
*/
getCalculateFormula() {
}
/**
* Indicates whether to calculate formulas before saving html file.
* The default value is false.
*/
setCalculateFormula(value) {
}
/**
* Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
* The default value is true.
*/
isJsBrowserCompatible() {
}
/**
* Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
* The default value is true.
*/
setJsBrowserCompatible(value) {
}
/**
* Indicates whether the output HTML is compatible with mobile devices.
* The default value is false.
*/
isMobileCompatible() {
}
/**
* Indicates whether the output HTML is compatible with mobile devices.
* The default value is false.
*/
setMobileCompatible(value) {
}
/**
* Gets or sets the additional css styles for the formatter.
* Only works when SaveAsSingleFile is True.
* Example:
* CssStyles="body { padding: 5px }";
*/
getCssStyles() {
}
/**
* Gets or sets the additional css styles for the formatter.
* Only works when SaveAsSingleFile is True.
* Example:
* CssStyles="body { padding: 5px }";
*/
setCssStyles(value) {
}
/**
* Indicates whether to hide overflow text when the cell format is set to wrap text.
* The default value is false
*/
getHideOverflowWrappedText() {
}
/**
* Indicates whether to hide overflow text when the cell format is set to wrap text.
* The default value is false
*/
setHideOverflowWrappedText(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents a character encoding.
* @hideconstructor
*/
class Encoding {
/**
* Gets an encoding for the ASCII (7-bit) character set.
* @return {Encoding} A Encoding object for the ASCII (7-bit) character set.
*/
static getASCII() {
}
/**
* Gets an encoding for the UTF-7 format.
* @return {Encoding} A Encoding object for the UTF-7 format.
*/
static getUTF7() {
}
/**
* Gets an encoding for the UTF-8 format.
* @return {Encoding} A Encoding object for the UTF-8 format.
*/
static getUTF8() {
}
/**
* Gets an encoding for the UTF-8 format without the UTF-8 identifier.
* @return {Encoding} A Encoding object for the UTF-8 format without UTF-8 identifier.
*/
static getUTF8NoBOM() {
}
/**
* Gets an encoding for the UTF-16 format using the little endian byte order.
* @return {Encoding} A Encoding object for the UTF-16 format using the little endian byte
*/
static getUnicode() {
}
/**
* Gets an encoding for the UTF-16 format using the big endian byte order.
* @return {Encoding} A Encoding object for the UTF-16 format using the big endian byte
*/
static getBigEndianUnicode() {
}
/**
* Gets an encoding for the operating system's current ANSI code page.
* @return {Encoding} An encoding for the operating system's current ANSI code page.
*/
static getDefault() {
}
/**
* Returns the encoding associated with the specified code page identifier.
* @param {Number} codePage - The code page identifier of the preferred encoding. -or- 0, to use the default encoding.
* @return {Encoding} The Encoding object associated with the specified code page.
*/
static getEncoding(codePage) {
}
/**
* Returns an encoding associated with the specified charset name.
* @param {String} charsetName - specified charset name
* @return {Encoding} The Encoding object associated with the specified charset name.
*/
static getEncoding(charsetName) {
}
/**
* Returns an encoding associated with the specified charset object.
* @param {Charset} charset - specified charset object
* @return {Encoding} The Encoding object associated with the specified charset object.
*/
static getEncoding(charset) {
}
/**
* Determines whether the specified Object is equal to the current instance.
* @param {Object} o - The Object to compare with the current instance.
* @return {boolean} true if value is an instance of Encoding and is equal to the current instance; otherwise, false.
*/
equals(o) {
}
/**
* Determines whether the specified Encoding object is equal to the current instance.
* @param {Encoding} other - The Encoding object to compare with the current instance.
* @return {boolean} true if value is equal to the current instance; otherwise, false.
*/
equals(other) {
}
}
/**
* 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'.
* @hideconstructor
*/
class EquationComponentNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Abstract class for deriving other equation nodes.
* @hideconstructor
*/
class EquationNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Create a node of the specified type.
* @param {Number} equationType - EquationNodeType
* @param {Workbook} workbook - The workbook object associated with the equation
* @param {EquationNode} parent - The parent node where this node is located
* @return {EquationNode} 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, workbook, parent) {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* This class specifies a mathematical paragraph containing one or more MathEquationNode(OMath) elements.
* @hideconstructor
*/
class EquationNodeParagraph {
/**
* 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.
* The value of the property is EquationHorizontalJustificationType integer constant.
*/
getJustification() {
}
/**
* 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.
* The value of the property is EquationHorizontalJustificationType integer constant.
*/
setJustification(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents error bar of data series.
* @example
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* cells.get("a1").putValue(2);
* cells.get("a2").putValue(5);
* cells.get("a3").putValue(3);
* cells.get("a4").putValue(6);
* cells.get("b1").putValue(4);
* cells.get("b2").putValue(3);
* cells.get("b3").putValue(6);
* cells.get("b4").putValue(7);
* cells.get("C1").putValue("Q1");
* cells.get("C2").putValue("Q2");
* cells.get("C3").putValue("Y1");
* cells.get("C4").putValue("Y2");
* var chartIndex = workbook.getWorksheets().get(0).getCharts().add(aspose.cells.ChartType.COLUMN, 11, 0, 27, 10);
* var chart = workbook.getWorksheets().get(0).getCharts().get(chartIndex);
* chart.getNSeries().add("A1:B4", true);
* chart.getNSeries().setCategoryData("C1:C4");
* for (var i = 0; i < chart.getNSeries().getCount(); i++)
* {
* var aseries = chart.getNSeries().get(i);
* aseries.getXErrorBar().setDisplayType(aspose.cells.ErrorBarDisplayType.MINUS);
* aseries.getXErrorBar().setType(aspose.cells.ErrorBarType.FIXED_VALUE);
* aseries.getXErrorBar().setAmount(5);
* }
* @hideconstructor
*/
class ErrorBar {
/**
* Represents error bar amount type.
* The value of the property is ErrorBarType integer constant.
* @example
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* cells.get("a1").putValue(2);
* cells.get("a2").putValue(5);
* cells.get("a3").putValue(3);
* cells.get("a4").putValue(6);
* cells.get("b1").putValue(4);
* cells.get("b2").putValue(3);
* cells.get("b3").putValue(6);
* cells.get("b4").putValue(7);
* cells.get("C1").putValue("Q1");
* cells.get("C2").putValue("Q2");
* cells.get("C3").putValue("Y1");
* cells.get("C4").putValue("Y2");
* var chartIndex = workbook.getWorksheets().get(0).getCharts().add(aspose.cells.ChartType.COLUMN, 11, 0, 27, 10);
* var chart = workbook.getWorksheets().get(0).getCharts().get(chartIndex);
* chart.getNSeries().add("A1:B4", true);
* chart.getNSeries().setCategoryData("C1:C4");
* for (var i = 0; i < chart.getNSeries().getCount(); i++)
* {
* var aseries = chart.getNSeries().get(i);
* //Sets custom error bar type
* aseries.getXErrorBar().setType(aspose.cells.ErrorBarType.CUSTOM);
* aseries.getXErrorBar().setPlusValue("=Sheet1!A1");
* aseries.getXErrorBar().setMinusValue("=Sheet1!A2");
* }
*/
getType() {
}
/**
* Represents error bar amount type.
* The value of the property is ErrorBarType integer constant.
* @example
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* cells.get("a1").putValue(2);
* cells.get("a2").putValue(5);
* cells.get("a3").putValue(3);
* cells.get("a4").putValue(6);
* cells.get("b1").putValue(4);
* cells.get("b2").putValue(3);
* cells.get("b3").putValue(6);
* cells.get("b4").putValue(7);
* cells.get("C1").putValue("Q1");
* cells.get("C2").putValue("Q2");
* cells.get("C3").putValue("Y1");
* cells.get("C4").putValue("Y2");
* var chartIndex = workbook.getWorksheets().get(0).getCharts().add(aspose.cells.ChartType.COLUMN, 11, 0, 27, 10);
* var chart = workbook.getWorksheets().get(0).getCharts().get(chartIndex);
* chart.getNSeries().add("A1:B4", true);
* chart.getNSeries().setCategoryData("C1:C4");
* for (var i = 0; i < chart.getNSeries().getCount(); i++)
* {
* var aseries = chart.getNSeries().get(i);
* //Sets custom error bar type
* aseries.getXErrorBar().setType(aspose.cells.ErrorBarType.CUSTOM);
* aseries.getXErrorBar().setPlusValue("=Sheet1!A1");
* aseries.getXErrorBar().setMinusValue("=Sheet1!A2");
* }
*/
setType(value) {
}
/**
* Represents error bar display type.
* The value of the property is ErrorBarDisplayType integer constant.
*/
getDisplayType() {
}
/**
* Represents error bar display type.
* The value of the property is ErrorBarDisplayType integer constant.
*/
setDisplayType(value) {
}
/**
* Represents amount of error bar.
* The amount must be greater than or equal to zero.
*/
getAmount() {
}
/**
* Represents amount of error bar.
* The amount must be greater than or equal to zero.
*/
setAmount(value) {
}
/**
* Indicates if formatting error bars with a T-top.
*/
getShowMarkerTTop() {
}
/**
* Indicates if formatting error bars with a T-top.
*/
setShowMarkerTTop(value) {
}
/**
* Represents positive error amount when error bar type is Custom.
*/
getPlusValue() {
}
/**
* Represents positive error amount when error bar type is Custom.
*/
setPlusValue(value) {
}
/**
* Represents negative error amount when error bar type is Custom.
*/
getMinusValue() {
}
/**
* Represents negative error amount when error bar type is Custom.
*/
setMinusValue(value) {
}
/**
* Specifies the compound line type
* The value of the property is MsoLineStyle integer constant.
*/
getCompoundType() {
}
/**
* Specifies the compound line type
* The value of the property is MsoLineStyle integer constant.
*/
setCompoundType(value) {
}
/**
* Specifies the dash line type
* The value of the property is MsoLineDashStyle integer constant.
*/
getDashType() {
}
/**
* Specifies the dash line type
* The value of the property is MsoLineDashStyle integer constant.
*/
setDashType(value) {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
getCapType() {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
setCapType(value) {
}
/**
* Specifies the joining caps.
* The value of the property is LineJoinType integer constant.
*/
getJoinType() {
}
/**
* Specifies the joining caps.
* The value of the property is LineJoinType integer constant.
*/
setJoinType(value) {
}
/**
* Specifies an arrowhead for the begin of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getBeginType() {
}
/**
* Specifies an arrowhead for the begin of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setBeginType(value) {
}
/**
* Specifies an arrowhead for the end of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getEndType() {
}
/**
* Specifies an arrowhead for the end of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setEndType(value) {
}
/**
* Specifies the length of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getBeginArrowLength() {
}
/**
* Specifies the length of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setBeginArrowLength(value) {
}
/**
* Specifies the length of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getEndArrowLength() {
}
/**
* Specifies the length of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setEndArrowLength(value) {
}
/**
* Specifies the width of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getBeginArrowWidth() {
}
/**
* Specifies the width of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setBeginArrowWidth(value) {
}
/**
* Specifies the width of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getEndArrowWidth() {
}
/**
* Specifies the width of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setEndArrowWidth(value) {
}
/**
* Gets and sets the theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
getThemeColor() {
}
/**
* Gets and sets the theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
setThemeColor(value) {
}
/**
* Represents the com.aspose.cells.Color of the line.
*/
getColor() {
}
/**
* Represents the com.aspose.cells.Color of the line.
*/
setColor(value) {
}
/**
* Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Represents the style of the line.
* The value of the property is LineType integer constant.
*/
getStyle() {
}
/**
* Represents the style of the line.
* The value of the property is LineType integer constant.
*/
setStyle(value) {
}
/**
* Gets or sets the WeightType of the line.
* The value of the property is WeightType integer constant.
*/
getWeight() {
}
/**
* Gets or sets the WeightType of the line.
* The value of the property is WeightType integer constant.
*/
setWeight(value) {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
getWeightPt() {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
setWeightPt(value) {
}
/**
* Gets or sets the weight of the line in unit of pixels.
*/
getWeightPx() {
}
/**
* Gets or sets the weight of the line in unit of pixels.
*/
setWeightPx(value) {
}
/**
* Gets or sets format type.
* The value of the property is ChartLineFormattingType integer constant.
*/
getFormattingType() {
}
/**
* Gets or sets format type.
* The value of the property is ChartLineFormattingType integer constant.
*/
setFormattingType(value) {
}
/**
* Indicates whether the color of line is automatic assigned.
*/
isAutomaticColor() {
}
/**
* Represents whether the line is visible.
*/
isVisible() {
}
/**
* Represents whether the line is visible.
*/
setVisible(value) {
}
/**
* Indicates whether this line style is auto assigned.
*/
isAuto() {
}
/**
* Indicates whether this line style is auto assigned.
*/
setAuto(value) {
}
/**
* Represents gradient fill.
*/
getGradientFill() {
}
}
/**
* Error check setting applied on certain ranges.
* @hideconstructor
*/
class ErrorCheckOption {
/**
* Checks whether given error type will be checked.
* @param {Number} errorCheckType - ErrorCheckType
* @return {boolean} return true if given error type will be checked(green triangle will be shown for cell if the check failed).
*/
isErrorCheck(errorCheckType) {
}
/**
* Sets whether given error type will be checked.
* @param {Number} errorCheckType - ErrorCheckType
* @param {boolean} isCheck - true if given error type needs to be checked(green triangle will be shown for cell if the check failed).
*/
setErrorCheck(errorCheckType, isCheck) {
}
/**
* Gets the count of ranges that influenced by this setting.
* @return {Number} the count of ranges that influenced by this setting.
*/
getCountOfRange() {
}
/**
* Adds one influenced range by this setting.
* @param {CellArea} ca - the range to be added.
* @return {Number} the index of the added range in the range list of this setting.
*/
addRange(ca) {
}
/**
* Gets the influenced range of this setting by given index.
* @param {Number} index - the index of range
* @return {CellArea} return influenced range at given index.
*/
getRange(index) {
}
/**
* Removes one range by given index.
* @param {Number} index - the index of the range to be removed.
*/
removeRange(index) {
}
}
/**
* Represents all error check option.
* @hideconstructor
*/
class ErrorCheckOptionCollection {
/**
*/
getCount() {
}
/**
* Gets ErrorCheckOption object by the given index.
* @param {Number} index - The index
* @return {ErrorCheckOption} Return ErrorCheckOption object
*/
get(index) {
}
/**
* Add an error check option.
* @return {Number}
*/
add() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Indicates the options that exporting range to json.
*/
class ExportRangeToJsonOptions {
/**
*/
constructor() {
}
/**
* Indicates whether the range contains header row.
*/
hasHeaderRow() {
}
/**
* Indicates whether the range contains header row.
*/
setHasHeaderRow(value) {
}
/**
* Exports the string value of the cells to json.
*/
getExportAsString() {
}
/**
* Exports the string value of the cells to json.
*/
setExportAsString(value) {
}
/**
* Indicates whether exporting empty cells as null.
*/
getExportEmptyCells() {
}
/**
* Indicates whether exporting empty cells as null.
*/
setExportEmptyCells(value) {
}
/**
* Indicates the indent.
* If the indent is null or empty, the exported json is not formatted.
*/
getIndent() {
}
/**
* Indicates the indent.
* If the indent is null or empty, the exported json is not formatted.
*/
setIndent(value) {
}
}
/**
* Specifies an external data connection
* @hideconstructor
*/
class ExternalConnection {
/**
* Gets the id of the connection.
*/
getId() {
}
/**
* Gets the definition of power query formula.
*/
getPowerQueryFormula() {
}
/**
* Gets or Sets the external connection DataSource type.
*/
getType() {
}
/**
* 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() {
}
/**
* 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.
*/
setSourceFile(value) {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
getSSOId() {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
setSSOId(value) {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
getSavePassword() {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
setSavePassword(value) {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
getSaveData() {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
setSaveData(value) {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
getRefreshOnLoad() {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
setRefreshOnLoad(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
getReconnectionMethodType() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
setReconnectionMethodType(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getReconnectionMethod() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setReconnectionMethod(value) {
}
/**
* 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() {
}
/**
* 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
*/
setOnlyUseConnectionFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOdcFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setNew(value) {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
getName() {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
setName(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setKeepAlive(value) {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
getRefreshInternal() {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
setRefreshInternal(value) {
}
/**
* Specifies The unique identifier of this connection.
*/
getConnectionId() {
}
/**
* Specifies the user description for this connection
*/
getConnectionDescription() {
}
/**
* Specifies the user description for this connection
*/
setConnectionDescription(value) {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
isDeleted() {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
setDeleted(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
getCredentialsMethodType() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
setCredentialsMethodType(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getCredentials() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCredentials(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setBackgroundRefresh(value) {
}
/**
* Gets ConnectionParameterCollection for an ODBC or web query.
*/
getParameters() {
}
}
/**
* Specifies the ExternalConnection collection
* @hideconstructor
*/
class ExternalConnectionCollection {
/**
*/
getCount() {
}
/**
* Gets the ExternalConnection element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ExternalConnection} The element at the specified index.
*/
get(index) {
}
/**
* Gets the ExternalConnection element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ExternalConnection} The element at the specified index.
*/
set(index, value) {
}
/**
* Gets the ExternalConnection element with the specified name.
* @param {String} connectionName - the name of data connection
* @return {ExternalConnection} The element with the specified name.
*/
get(connectionName) {
}
/**
* Gets the ExternalConnection element with the specified id.
* @param {Number} connId - external connection id
* @return {ExternalConnection} The element with the specified id.
*/
getExternalConnectionById(connId) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents an external link in a workbook.
* @example
* //Open a file with external links
* var workbook = new aspose.cells.Workbook("d:\\book1.xls");
* //Get External Link
* var externalLink = workbook.getWorksheets().getExternalLinks().get(0);
* //Change External Link's Data Source
* externalLink.setDataSource("d:\\link.xls");
* @hideconstructor
*/
class ExternalLink {
/**
* Gets the type of external link.
* The value of the property is ExternalLinkType integer constant.
*/
getType() {
}
/**
* Get the path type of this external link
*/
getPathType() {
}
/**
* Represents stored data source of the external link.
*/
getOriginalDataSource() {
}
/**
* Represents stored data source of the external link.
*/
setOriginalDataSource(value) {
}
/**
* Represents data source of the external link.
*/
getDataSource() {
}
/**
* Represents data source of the external link.
*/
setDataSource(value) {
}
/**
* Indicates whether this external link is referenced by others.
*/
isReferred() {
}
/**
* Indicates whether this external link is visible in MS Excel.
*/
isVisible() {
}
/**
* Adds an external name.
* @param {String} text - The text of the external name.
* If the external name belongs to a worksheet, the text should be as Sheet1!Text.
* @param {String} referTo - The referTo of the external name. It must be a cell or the range.
*/
addExternalName(text, referTo) {
}
}
/**
* Represents external links collection in a workbook.
* @example
* //Open a file with external links
* var workbook = new aspose.cells.Workbook("Book1.xls");
* //Change external link data source
* workbook.getWorksheets().getExternalLinks().get(0).setDataSource("Book2.xls");
* @hideconstructor
*/
class ExternalLinkCollection {
/**
* Gets the number of elements actually contained in the collection.
*/
getCount() {
}
/**
* Gets the ExternalLink element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ExternalLink} The element at the specified index.
*/
get(index) {
}
/**
* Adds an external link.
* @param {String} fileName - The external file name.
* @param {String[]} sheetNames - All sheet names of the external file.
* @return {Number} The position of the external name in this list.
*/
add(fileName, sheetNames) {
}
/**
* Add an external link .
* @param {Number} directoryType - DirectoryType
* @param {String} fileName - the file name.
* @param {String[]} sheetNames - All sheet names of the external file.
* @return {Number} The position of the external name in this list.
*/
add(directoryType, fileName, sheetNames) {
}
/**
* Removes all external links.
* When removing external links, all formulas that reference to them will be removed too because
* the references become invalid.
*/
clear() {
}
/**
* Removes all external links.
* If references are required to be updated, those references of external links in formulas
* will be changed to current workbook when it is possible.
* For example, one cell's original formula is "='externalsource.xlam'!customfunction()",
* after removing external links, the formula will become "=customfunction()";
* When the original formula is "='[externalsource.xlam]Sheet1'!$A$1",
* according to whether there is one sheet with name "Sheet1" in current workbook:
* if true, the formula will become "=Sheet1!$A$1";
* if false, the formula will become "=#REF!$A$1".
* If references are not required to be updated, all formulas with references to external links
* will be removed too because those references become invalid.
* @param {boolean} updateReferencesAsLocal -
* Whether update all references of external links in formulas to references of current workbook itself.
*/
clear(updateReferencesAsLocal) {
}
/**
* Removes the specified external link from the workbook.
* When removing the external link, all formulas that reference to it will be removed too because
* the references become invalid.
* @param {Number} index - the index of the external link to be removed.
*/
removeAt(index) {
}
/**
* Removes the specified external link from the workbook.
* @param {Number} index - the index of the external link to be removed.
* @param {boolean} updateReferencesAsLocal -
* Whether update all references of given external link to reference of current workbook itself.
* Check
*/
removeAt(index, updateReferencesAsLocal) {
}
/**
* Get an enumerator that iterates through this collection.
* @return {Iterator}
*/
iterator() {
}
}
/**
* Represents the single TrueType font file stored in the file system.
*/
class FileFontSource {
/**
* Ctor.
* @param {String} filePath - path to font file
*/
constructor(filePath) {
}
/**
* Path to font file.
*/
getFilePath() {
}
/**
* Returns the type of the font source.
* The value of the property is FontSourceType integer constant.
*/
getType() {
}
}
/**
* Contains data returned by FileFormatUtil file format detection methods.
*/
class FileFormatInfo {
/**
*/
constructor() {
}
/**
* Gets whether the file is protected by Microsoft Rights Management Server.
*/
isProtectedByRMS() {
}
/**
* Returns true if the document is encrypted and requires a password to open.
*/
isEncrypted() {
}
/**
* Gets the detected file format.
* The value of the property is FileFormatType integer constant.
*/
getFileFormatType() {
}
/**
* Gets the detected load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
}
/**
* Provides utility methods for converting file format enums to strings or file extensions and back.
* @hideconstructor
*/
class FileFormatUtil {
/**
* Detects and returns the information about a format of an excel stored in a stream.
* @param {InputStream} stream - The stream
* @return {FileFormatInfo} A FileFormatInfo object that contains the detected information.
*/
static detectFileFormat(stream) {
}
/**
* Detects and returns the information about a format of an excel stored in a stream.
* @param {InputStream} stream
* @param {String} password - The password for encrypted ooxml files.
* @return {FileFormatInfo} A FileFormatInfo object that contains the detected information.
*/
static detectFileFormat(stream, password) {
}
/**
* Detects and returns the information about a format of an excel stored in a stream.
* @param {InputStream} stream
* @param {String} password - The password for encrypted ooxml files.
* @return {boolean} Returns whether the password is corrected.
*/
static verifyPassword(stream, password) {
}
/**
* Detects and returns the information about a format of an excel stored in a file.
* @param {String} filePath - The file path.
* @return {FileFormatInfo} A FileFormatInfo object that contains the detected information.
*/
static detectFileFormat(filePath) {
}
/**
* Detects and returns the information about a format of an excel stored in a file.
* @param {String} filePath - The file path.
* @param {String} password - The password for encrypted ooxml files.
* @return {FileFormatInfo} A FileFormatInfo object that contains the detected information.
*/
static detectFileFormat(filePath, password) {
}
/**
* Converting file format to save format.
* @param {Number} format - FileFormatType
* @return {Number} A SaveFormat value.
*/
static fileFormatToSaveFormat(format) {
}
/**
* Converts a file name extension into a SaveFormat value.
* If the extension cannot be recognized, returns SaveFormat.UNKNOWN.
* @param {String} extension - The file extension. Can be with or without a leading dot. Case-insensitive.
* @return {Number} A SaveFormat value.
*/
static extensionToSaveFormat(extension) {
}
/**
* Returns true if the extension is .xlt, .xltX, .xltm,.ots.
* @param {String} extension
* @return {boolean}
*/
static isTemplateFormat(extension) {
}
/**
* Converts a load format enumerated value into a file extension.
* If it can not be converted, returns null.
* @param {Number} loadFormat - LoadFormat
* @return {String} The returned extension is a lower-case string with a leading dot.
*/
static loadFormatToExtension(loadFormat) {
}
/**
* Converts a LoadFormat value to a SaveFormat value if possible.
* @param {Number} loadFormat - LoadFormat
* @return {Number} A SaveFormat value. The save format.
*/
static loadFormatToSaveFormat(loadFormat) {
}
/**
* Converts a save format enumerated value into a file extension.
* @param {Number} format - SaveFormat
* @return {String} The returned extension is a lower-case string with a leading dot.
*/
static saveFormatToExtension(format) {
}
/**
* Converts a SaveFormat value to a LoadFormat value if possible.
* @param {Number} saveFormat - SaveFormat
* @return {Number} A LoadFormat value. The load format
*/
static saveFormatToLoadFormat(saveFormat) {
}
/**
* Detects and returns the information about a format of an excel stored in a stream.
* @param {ReadableStream} stream - The stream
* @param {Callback} callback - The callback function
* @return {FileFormatInfo} A FileFormatInfo object that contains the detected information.
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var readStream = fs.createReadStream("Book2.xlsx");
* aspose.cells.FileFormatUtil.detectFileFormatFromStream(readStream, function(result, err) {
* if (!err) {
* console.log("detect result: " + result.getFileFormatType());
* }
* });
*/
static detectFileFormatFromStream(stream, callback) {
}
}
/**
* Represents the fill format of the shape.
* @hideconstructor
*/
class Fill {
/**
* /
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* Encapsulates the object that represents fill formatting for a shape.
* @example
* var excel = new aspose.cells.Workbook();
* var charts = excel.getWorksheets().get(0).getCharts();
* //Create a chart
* var chart = charts.get(charts.add(aspose.cells.ChartType.COLUMN, 1, 1, 10, 10));
* chart.getNSeries().add("A1:C5", true);
* //Filling the area of the 2nd NSeries with a gradient
* chart.getNSeries().get(1).getArea().getFillFormat().setOneColorGradient(aspose.cells.Color.getLime(), 1, aspose.cells.GradientStyleType.HORIZONTAL, 1);
* @hideconstructor
*/
class FillFormat {
/**
* Gets and sets the fill type.
* The value of the property is FillType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getType() {
}
/**
* Gets and sets the fill type.
* The value of the property is FillType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setType(value) {
}
/**
* Gets and sets fill type
* The value of the property is FillType integer constant.
*/
getFillType() {
}
/**
* Gets and sets fill type
* The value of the property is FillType integer constant.
*/
setFillType(value) {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets the fill format set type.
* The value of the property is FormatSetType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSetType() {
}
/**
* Gets the fill format set type.
* The value of the property is FormatSetType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSetType(value) {
}
/**
* Gets GradientFill object.
*/
getGradientFill() {
}
/**
* Gets TextureFill object.
*/
getTextureFill() {
}
/**
* Gets SolidFill object.
*/
getSolidFill() {
}
/**
* Gets PatternFill object.
*/
getPatternFill() {
}
/**
* Returns the gradient color type for the specified fill.
* The value of the property is GradientColorType integer constant.
*/
getGradientColorType() {
}
/**
* Returns the gradient style for the specified fill.
* The value of the property is GradientStyleType integer constant.
*/
getGradientStyle() {
}
/**
* Returns the gradient color 1 for the specified fill.
*/
getGradientColor1() {
}
/**
* Returns the gradient color 2 for the specified fill.
* Only when the gradient color type is GradientColorType.TwoColors, this property is meaningful.
*/
getGradientColor2() {
}
/**
* Returns the gradient degree for the specified fill.
* Only applies for Excel 2007.
* Can only be a value from 0.0 (dark) through 1.0 (light).
*/
getGradientDegree() {
}
/**
* Returns the gradient variant for the specified fill.
* Only applies for Excel 2007.
* 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() {
}
/**
* Returns the gradient preset color for the specified fill.
* The value of the property is GradientPresetType integer constant.
*/
getPresetColor() {
}
/**
* Represents the texture type for the specified fill.
* The value of the property is TextureType integer constant.
*/
getTexture() {
}
/**
* Represents the texture type for the specified fill.
* The value of the property is TextureType integer constant.
*/
setTexture(value) {
}
/**
* Represents an area's display pattern.
* The value of the property is FillPattern integer constant.
*/
getPattern() {
}
/**
* Represents an area's display pattern.
* The value of the property is FillPattern integer constant.
*/
setPattern(value) {
}
/**
* Gets and sets the picture format type.
* The value of the property is FillPictureType integer constant.
*/
getPictureFormatType() {
}
/**
* Gets and sets the picture format type.
* The value of the property is FillPictureType integer constant.
*/
setPictureFormatType(value) {
}
/**
* Gets and sets the picture format scale.
*/
getScale() {
}
/**
* Gets and sets the picture format scale.
*/
setScale(value) {
}
/**
* Gets and sets the picture image data.
* If the fill format is not custom texture format, returns null.
*/
getImageData() {
}
/**
* Gets and sets the picture image data.
* If the fill format is not custom texture format, returns null.
*/
setImageData(value) {
}
/**
* Sets the specified fill to a one-color gradient.
* Only applies for Excel 2007.
* @param {Color} color - One gradient color.
* @param {Number} degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).
* @param {Number} style - GradientStyleType
* @param {Number} 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, degree, style, variant) {
}
/**
* Sets the specified fill to a two-color gradient.
* Only applies for Excel 2007.
* @param {Color} color1 - One gradient color.
* @param {Color} color2 - Two gradient color.
* @param {Number} style - GradientStyleType
* @param {Number} 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, color2, style, variant) {
}
/**
* Sets the specified fill to a two-color gradient.
* Only applies for Excel 2007.
* @param {Color} color1 - One gradient color.
* @param {Number} transparency1 - The degree of transparency of the color1 as a value from 0.0 (opaque) through 1.0 (clear).
* @param {Color} color2 - Two gradient color.
* @param {Number} transparency2 - The degree of transparency of the color2 as a value from 0.0 (opaque) through 1.0 (clear).
* @param {Number} style - GradientStyleType
* @param {Number} 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, transparency1, color2, transparency2, style, variant) {
}
/**
* Sets the specified fill to a preset-color gradient.
* Only applies for Excel 2007.
* @param {Number} presetColor - GradientPresetType
* @param {Number} style - GradientStyleType
* @param {Number} 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, style, variant) {
}
/**
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* Represents a filter for a single column. The Filter object is a member of the Filters collection
* @hideconstructor
*/
class FilterColumn {
/**
* Indicates whether the AutoFilter button for this column is visible.
*/
isDropdownVisible() {
}
/**
* Indicates whether the AutoFilter button for this column is visible.
*/
setDropdownVisible(value) {
}
/**
* Gets and sets the condition of filtering data.
*/
getFilter() {
}
/**
* Gets and sets the condition of filtering data.
*/
setFilter(value) {
}
/**
* Gets and sets the type fo filtering data.
* The value of the property is FilterType integer constant.
*/
getFilterType() {
}
/**
* Gets and sets the type fo filtering data.
* The value of the property is FilterType integer constant.
*/
setFilterType(value) {
}
/**
* Gets and sets the column offset in the range.
*/
getFieldIndex() {
}
/**
* Gets and sets the column offset in the range.
*/
setFieldIndex(value) {
}
}
/**
* A collection of Filter objects that represents all the filters in an autofiltered range.
* @hideconstructor
*/
class FilterColumnCollection {
/**
*/
getCount() {
}
/**
* Gets FilterColumn object at the special field.
* @param {Number} 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).
* @return {FilterColumn}
* Returns FilterColumn object.
*/
get(fieldIndex) {
}
/**
* @param {Number} index
*/
removeAt(index) {
}
/**
* Returns a single Filter object from a collection.
*/
getByIndex(index) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents find options.
* @example
* //Instantiate the workbook object
* var workbook = new aspose.cells.Workbook("Book1.xls");
* //Get Cells collection
* var cells = workbook.getWorksheets().get(0).getCells();
* //Instantiate FindOptions Object
* var findOptions = new aspose.cells.FindOptions();
* //Create a Cells Area
* var ca = new aspose.cells.CellArea();
* ca.StartRow = 8;
* ca.StartColumn = 2;
* ca.EndRow = 17;
* ca.EndColumn = 13;
* //Set cells area for find options
* findOptions.setRange(ca);
* //Set searching properties
* findOptions.setSearchNext(true);
* findOptions.setSeachOrderByRows(true);
* findOptions.setLookInType(aspose.cells.LookInType.VALUES);
* //Find the cell with 0 value
* var cell = cells.find(0, null, findOptions);
*/
class FindOptions {
/**
*/
constructor() {
}
/**
* Indicates if the searched string is case sensitive.
*/
getCaseSensitive() {
}
/**
* Indicates if the searched string is case sensitive.
*/
setCaseSensitive(value) {
}
/**
* Look at type.
* The value of the property is LookAtType integer constant.
*/
getLookAtType() {
}
/**
* Look at type.
* The value of the property is LookAtType integer constant.
*/
setLookAtType(value) {
}
/**
* Indicates whether the searched range is set.
*/
isRangeSet() {
}
/**
* Search order. True: search next. False: search previous.
* NOTE: This member is now obsolete. Instead,
* please use FindOptions.SearchBackward property.
* This property will be removed 12 months later since November 2018.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSearchNext() {
}
/**
* Search order. True: search next. False: search previous.
* NOTE: This member is now obsolete. Instead,
* please use FindOptions.SearchBackward property.
* This property will be removed 12 months later since November 2018.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSearchNext(value) {
}
/**
* Whether search backward for cells.
*/
getSearchBackward() {
}
/**
* Whether search backward for cells.
*/
setSearchBackward(value) {
}
/**
* Indicates whether search order by rows or columns.
*/
getSeachOrderByRows() {
}
/**
* Indicates whether search order by rows or columns.
*/
setSeachOrderByRows(value) {
}
/**
* Look in type.
* The value of the property is LookInType integer constant.
*/
getLookInType() {
}
/**
* Look in type.
* The value of the property is LookInType integer constant.
*/
setLookInType(value) {
}
/**
* Indicates whether the searched key is regex.
* If true the searched key will be taken as regex and parsed. Otherwise the key will be parsed according to the rules in ms excel.
*/
getRegexKey() {
}
/**
* Indicates whether the searched key is regex.
* If true the searched key will be taken as regex and parsed. Otherwise the key will be parsed according to the rules in ms excel.
*/
setRegexKey(value) {
}
/**
* Indicates whether searched cell value type should be same with the searched key.
*/
getValueTypeSensitive() {
}
/**
* Indicates whether searched cell value type should be same with the searched key.
*/
setValueTypeSensitive(value) {
}
/**
* The format to search for.
*/
getStyle() {
}
/**
* The format to search for.
*/
setStyle(value) {
}
/**
* Gets or sets a value that indicates whether converting the searched string value to numeric data.
*/
getConvertNumericData() {
}
/**
* Gets or sets a value that indicates whether converting the searched string value to numeric data.
*/
setConvertNumericData(value) {
}
/**
* Gets and sets the searched range.
* @return {CellArea}
* Returns the searched range.
*/
getRange() {
}
/**
* Sets the searched range.
* @param {CellArea} ca - the searched range.
*/
setRange(ca) {
}
}
/**
* Encapsulates the object that represents the floor of a 3-D chart.
* @example
* //Instantiate the License class
* var license = new aspose.cells.License();
* //Pass only the name of the license file embedded in the assembly
* license.setLicense("Aspose.Cells.lic");
* //Instantiate the workbook object
* var workbook = new aspose.cells.Workbook();
* //Get cells collection
* var cells = workbook.getWorksheets().get(0).getCells();
* //Put values in cells
* cells.get("A1").putValue(1);
* cells.get("A2").putValue(2);
* cells.get("A3").putValue(3);
* //get charts colletion
* var charts = workbook.getWorksheets().get(0).getCharts();
* //add a new chart
* var index = charts.add(aspose.cells.ChartType.COLUMN_3_D_STACKED, 5, 0, 15, 5);
* //get the newly added chart
* var chart = charts.get(index);
* //set charts nseries
* chart.getNSeries().add("A1:A3", true);
* //Show data labels
* chart.getNSeries().get(0).getDataLabels().setShowValue(true);
* //Get chart's floor
* var floor = chart.getFloor();
* //set floor's border as red
* floor.getBorder().setColor(aspose.cells.Color.getRed());
* //set fill format
* floor.getFillFormat().setPresetColorGradient(aspose.cells.GradientPresetType.CALM_WATER, aspose.cells.GradientStyleType.DIAGONAL_DOWN, 2);
* //save the file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Floor {
/**
* Gets or sets the border Line.
*/
getBorder() {
}
/**
* Gets or sets the border Line.
*/
setBorder(value) {
}
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
getBackgroundColor() {
}
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
setBackgroundColor(value) {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
getForegroundColor() {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
setForegroundColor(value) {
}
/**
* Represents the formatting of the area.
* The value of the property is FormattingType integer constant.
*/
getFormatting() {
}
/**
* Represents the formatting of the area.
* The value of the property is FormattingType integer constant.
*/
setFormatting(value) {
}
/**
* If the property is true and the value of chart point is a negative number,
* the foreground color and background color will be exchanged.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(-100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "A3"
* chart.getNSeries().add("A1:A3", true);
* chart.getNSeries().get(0).getArea().setInvertIfNegative(true);
* //Setting the foreground color of the 1st NSeries area
* chart.getNSeries().get(0).getArea().setForegroundColor(aspose.cells.Color.getRed());
* //Setting the background color of the 1st NSeries area.
* //The displayed area color of second chart point will be the background color.
* chart.getNSeries().get(0).getArea().setBackgroundColor(aspose.cells.Color.getYellow());
* //Saving the Excel file
* workbook.save("C:\\book1.xls");
*/
getInvertIfNegative() {
}
/**
* If the property is true and the value of chart point is a negative number,
* the foreground color and background color will be exchanged.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(-100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "A3"
* chart.getNSeries().add("A1:A3", true);
* chart.getNSeries().get(0).getArea().setInvertIfNegative(true);
* //Setting the foreground color of the 1st NSeries area
* chart.getNSeries().get(0).getArea().setForegroundColor(aspose.cells.Color.getRed());
* //Setting the background color of the 1st NSeries area.
* //The displayed area color of second chart point will be the background color.
* chart.getNSeries().get(0).getArea().setBackgroundColor(aspose.cells.Color.getYellow());
* //Saving the Excel file
* workbook.save("C:\\book1.xls");
*/
setInvertIfNegative(value) {
}
/**
* Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
*/
getFillFormat() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
}
/**
* Represents the folder that contains TrueType font files.
*/
class FolderFontSource {
/**
* Ctor.
* @param {String} folderPath - path to fonts folder
* @param {boolean} scanSubfolders - Determines whether or not to scan subfolders.
*/
constructor(folderPath, scanSubfolders) {
}
/**
* Path to fonts folder.
*/
getFolderPath() {
}
/**
* Determines whether or not to scan the subfolders.
*/
getScanSubFolders() {
}
/**
* Returns the type of the font source.
* The value of the property is FontSourceType integer constant.
*/
getType() {
}
}
/**
* Encapsulates the font object used in a spreadsheet.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(0);
* //Accessing the "A1" cell from the worksheet
* var cell = worksheet.getCells().get("A1");
* //Adding some value to the "A1" cell
* cell.putValue("Hello Aspose!");
* var style = cell.getStyle();
* var font = style.getFont();
* //Setting the font name to "Times New Roman"
* font.setName("Times New Roman");
* //Setting font size to 14
* font.setSize(14);
* //setting font color as Red
* font.setColor(aspose.cells.Color.getRed());
* cell.setStyle(style);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Font {
/**
* Represent the character set.
*/
getCharset() {
}
/**
* Represent the character set.
*/
setCharset(value) {
}
/**
* Gets or sets a value indicating whether the font is italic.
*/
isItalic() {
}
/**
* Gets or sets a value indicating whether the font is italic.
*/
setItalic(value) {
}
/**
* Gets or sets a value indicating whether the font is bold.
*/
isBold() {
}
/**
* Gets or sets a value indicating whether the font is bold.
*/
setBold(value) {
}
/**
* Gets and sets the text caps type.
* The value of the property is TextCapsType integer constant.
*/
getCapsType() {
}
/**
* Gets and sets the text caps type.
* The value of the property is TextCapsType integer constant.
*/
setCapsType(value) {
}
/**
* Gets the strike type of the text.
* The value of the property is TextStrikeType integer constant.
*/
getStrikeType() {
}
/**
* Gets the strike type of the text.
* The value of the property is TextStrikeType integer constant.
*/
setStrikeType(value) {
}
/**
* Gets or sets a value indicating whether the font is single strikeout.
*/
isStrikeout() {
}
/**
* Gets or sets a value indicating whether the font is single strikeout.
*/
setStrikeout(value) {
}
/**
* Gets and sets the script offset,in unit of percentage
*/
getScriptOffset() {
}
/**
* Gets and sets the script offset,in unit of percentage
*/
setScriptOffset(value) {
}
/**
* Gets or sets a value indicating whether the font is super script.
*/
isSuperscript() {
}
/**
* Gets or sets a value indicating whether the font is super script.
*/
setSuperscript(value) {
}
/**
* Gets or sets a value indicating whether the font is subscript.
*/
isSubscript() {
}
/**
* Gets or sets a value indicating whether the font is subscript.
*/
setSubscript(value) {
}
/**
* Gets or sets the font underline type.
* The value of the property is FontUnderlineType integer constant.
*/
getUnderline() {
}
/**
* Gets or sets the font underline type.
* The value of the property is FontUnderlineType integer constant.
*/
setUnderline(value) {
}
/**
* Gets or sets the name of the Font.
* @example
* var font = style.getFont();
* font.setName("Times New Roman");
* cell.setStyle(style);
*/
getName() {
}
/**
* Gets or sets the name of the Font.
* @example
* var font = style.getFont();
* font.setName("Times New Roman");
* cell.setStyle(style);
*/
setName(value) {
}
/**
* Gets and sets the double size of the font.
*/
getDoubleSize() {
}
/**
* Gets and sets the double size of the font.
*/
setDoubleSize(value) {
}
/**
* Gets or sets the size of the font.
*/
getSize() {
}
/**
* Gets or sets the size of the font.
*/
setSize(value) {
}
/**
* Gets and sets the theme color.
* If the font color is not a theme color, NULL will be returned.
*/
getThemeColor() {
}
/**
* Gets and sets the theme color.
* If the font color is not a theme color, NULL will be returned.
*/
setThemeColor(value) {
}
/**
* Gets or sets the com.aspose.cells.Color of the font.
*/
getColor() {
}
/**
* Gets or sets the com.aspose.cells.Color of the font.
*/
setColor(value) {
}
/**
* Gets and sets the color with a 32-bit ARGB value.
*/
getArgbColor() {
}
/**
* Gets and sets the color with a 32-bit ARGB value.
*/
setArgbColor(value) {
}
/**
* Indicates whether the normalization of height that is to be applied to the text run.
*/
isNormalizeHeights() {
}
/**
* Indicates whether the normalization of height that is to be applied to the text run.
*/
setNormalizeHeights(value) {
}
/**
* Gets and sets the scheme type of the font.
* The value of the property is FontSchemeType integer constant.
*/
getSchemeType() {
}
/**
* Gets and sets the scheme type of the font.
* The value of the property is FontSchemeType integer constant.
*/
setSchemeType(value) {
}
/**
* Checks if two fonts are equals.
* @param {Font} font - Compared font object.
* @return {boolean} True if equal to the compared font object.
*/
equals(font) {
}
/**
* Returns a string represents the current Cell object.
* @return {String}
*/
toString() {
}
}
/**
* Specifies font settings
*/
class FontConfigs {
/**
*/
constructor() {
}
/**
* Gets or sets the default font name.
*/
getDefaultFontName() {
}
/**
* Gets or sets the default font name.
*/
setDefaultFontName(value) {
}
/**
* Indicate whether the font is available.
* @param {String} fontName - font name
* @return {boolean} true if font is available, otherwise false.
*/
static isFontAvailable(fontName) {
}
/**
* Font substitute names for given original font name.
* @param {String} originalFontName - Original font name.
* @param {String[]} substituteFontNames - List of font substitute names to be used if original font is not presented.
*/
static setFontSubstitutes(originalFontName, substituteFontNames) {
}
/**
* Returns array containing font substitute names to be used if original font is not presented.
* @param {String} originalFontName - originalFontName
* @return {String[]} An array containing font substitute names to be used if original font is not presented.
*/
static getFontSubstitutes(originalFontName) {
}
/**
* Sets the fonts folder
* @param {String} fontFolder - The folder that contains TrueType fonts.
* @param {boolean} recursive - Determines whether or not to scan subfolders.
*/
static setFontFolder(fontFolder, recursive) {
}
/**
* Sets the fonts folders
* @param {String[]} fontFolders - The folders that contains TrueType fonts.
* @param {boolean} recursive - Determines whether or not to scan subfolders.
*/
static setFontFolders(fontFolders, recursive) {
}
/**
* Sets the fonts sources.
* @param {FontSourceBase[]} sources - An array of sources that contain TrueType fonts.
*/
static setFontSources(sources) {
}
/**
* Sets the fonts exclusive sources. Only fonts in the sources will be used.
* System.setProperty("Aspose.Cells.FontDirExc", "fontExclusiveFolder") will be ignored if this is set.
* @param {FontSourceBase[]} exclusiveSources - An array of sources that contain TrueType fonts.
*/
static setFontExclusiveSources(exclusiveSources) {
}
/**
* Gets a copy of the array that contains the list of sources
* @return {FontSourceBase[]}
*/
static getFontSources() {
}
}
/**
* Represents a range of characters within the cell text.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Excel object
* workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(0);
* //Accessing the "A1" cell from the worksheet
* var cell = worksheet.getCells().get("A1");
* //Adding some value to the "A1" cell
* cell.putValue("Visit Aspose!");
* //getting charactor
* var charactor = cell.characters(6, 7);
* //Setting the font of selected characters to bold
* charactor.getFont().setBold(true);
* //Setting the font color of selected characters to blue
* charactor.getFont().setColor(aspose.cells.Color.getBlue());
* //Saving the Excel file
* workbook.save("Book1.xls");
*/
class FontSetting {
/**
* @param {Number} startIndex
* @param {Number} length
* @param {WorksheetCollection} sheets
*/
constructor(startIndex, length, sheets) {
}
/**
* Gets the type of text node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents the list of FontSetting.
* @hideconstructor
*/
class FontSettingCollection {
/**
* Represents the alignment setting of the text body.
*/
getTextAlignment() {
}
/**
* Gets all paragraphs.
*/
getTextParagraphs() {
}
/**
* Gets and sets the text of the shape.
*/
getText() {
}
/**
* Gets and sets the text of the shape.
*/
setText(value) {
}
/**
* Gets and sets the html string which contains data and some formats in this shape.
*/
getHtmlString() {
}
/**
* Gets and sets the html string which contains data and some formats in this shape.
*/
setHtmlString(value) {
}
/**
*/
getCount() {
}
/**
* Gets the FontSetting by the index.
* @param {Number} index - The index.
* @return {FontSetting}
*/
get(index) {
}
/**
* Sets the preset WordArt style.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
/**
* Gets the enumerator of the paragraphs.
* @return {Iterator}
*/
getParagraphEnumerator() {
}
/**
* Appends the text.
* @param {String} text - The text.
*/
appendText(text) {
}
/**
* Insert index at the position.
* @param {Number} index - The start index.
* @param {String} text - The text.
*/
insertText(index, text) {
}
/**
* Replace the text.
* @param {Number} index - The start index.
* @param {Number} count - The count of characters.
* @param {String} text - The text.
*/
replace(index, count, text) {
}
/**
* Replace the text.
* @param {String} oldValue - The old text.
* @param {String} newValue - The new text.
*/
replace(oldValue, newValue) {
}
/**
* Delete some characters.
* @param {Number} index - The start index.
* @param {Number} count - The count of characters.
*/
deleteText(index, count) {
}
/**
* Format the text with font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font.
* @param {StyleFlag} flag - The flags of the font.
*/
format(startIndex, length, font, flag) {
}
/**
* Clear all setting.
*/
clear() {
}
/**
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* @return {Number}
*/
hashCode() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* This is an abstract base class for the classes that allow the user to specify various font sources
* @hideconstructor
*/
class FontSourceBase {
/**
* Returns the type of the font source.
* The value of the property is FontSourceType integer constant.
*/
getType() {
}
}
/**
* This class specifies the 3D shape properties for a chart element or shape.
* @hideconstructor
*/
class Format3D {
/**
* Gets the Bevel object that holds the properties associated with defining a bevel on the top or front face of a shape.
*/
getTopBevel() {
}
/**
* 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.
* The value of the property is PresetMaterialType integer constant.
*/
getSurfaceMaterialType() {
}
/**
* 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.
* The value of the property is PresetMaterialType integer constant.
*/
setSurfaceMaterialType(value) {
}
/**
* Gets and sets the lighting type which is to be applied to the scene of the shape.
* Default value is LightRigType.ThreePoint.
* The value of the property is LightRigType integer constant.
*/
getSurfaceLightingType() {
}
/**
* Gets and sets the lighting type which is to be applied to the scene of the shape.
* Default value is LightRigType.ThreePoint.
* The value of the property is LightRigType integer constant.
*/
setSurfaceLightingType(value) {
}
/**
* Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
*/
getLightingAngle() {
}
/**
* Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
*/
setLightingAngle(value) {
}
/**
* Indicates if the shape has top bevel data.
* @return {boolean}
*/
hasTopBevelData() {
}
}
/**
* Represents conditional formatting condition.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* //Adds an empty conditional formatting
* var index = sheet.getConditionalFormattings().add();
* var fcs = sheet.getConditionalFormattings().get(index);
* //Sets the conditional format range.
* var ca = new aspose.cells.CellArea();
* ca.StartRow = 0;
* ca.EndRow = 0;
* ca.StartColumn = 0;
* ca.EndColumn = 0;
* fcs.addArea(ca);
* ca = new aspose.cells.CellArea();
* ca.StartRow = 1;
* ca.EndRow = 1;
* ca.StartColumn = 1;
* ca.EndColumn = 1;
* fcs.addArea(ca);
* //Adds condition.
* var conditionIndex = fcs.addCondition(aspose.cells.FormatConditionType.CELL_VALUE, aspose.cells.OperatorType.BETWEEN, "=A2", "100");
* //Adds condition.
* var conditionIndex2 = fcs.addCondition(aspose.cells.FormatConditionType.CELL_VALUE, aspose.cells.OperatorType.BETWEEN, "50", "100");
* //Sets the background color.
* var fc = fcs.get(conditionIndex);
* fc.getStyle().setBackgroundColor(aspose.cells.Color.getRed());
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class FormatCondition {
/**
* Gets and sets the value or expression associated with conditional formatting.
* 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() {
}
/**
* Gets and sets the value or expression associated with conditional formatting.
* 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) {
}
/**
* Gets and sets the value or expression associated with conditional formatting.
* 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() {
}
/**
* Gets and sets the value or expression associated with conditional formatting.
* 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) {
}
/**
* Gets and sets the conditional format operator type.
* The value of the property is OperatorType integer constant.OperatorType
*/
getOperator() {
}
/**
* Gets and sets the conditional format operator type.
* The value of the property is OperatorType integer constant.OperatorType
*/
setOperator(value) {
}
/**
* True, no rules with lower priority may be applied over this rule, when this rule evaluates to true.
* Only applies for Excel 2007;
*/
getStopIfTrue() {
}
/**
* True, no rules with lower priority may be applied over this rule, when this rule evaluates to true.
* Only applies for Excel 2007;
*/
setStopIfTrue(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setPriority(value) {
}
/**
* Gets or setts style of conditional formatted cell ranges.
*/
getStyle() {
}
/**
* Gets or setts style of conditional formatted cell ranges.
*/
setStyle(value) {
}
/**
* Gets and sets whether the conditional format Type.
* The value of the property is FormatConditionType integer constant.FormatConditionType
*/
getType() {
}
/**
* Gets and sets whether the conditional format Type.
* The value of the property is FormatConditionType integer constant.FormatConditionType
*/
setType(value) {
}
/**
* Get the conditional formatting's "IconSet" instance.
* The default instance's IconSetType is TrafficLights31.
* Valid only for type = IconSet.
* @return {IconSet}
*/
getIconSet() {
}
/**
* Get the conditional formatting's "DataBar" instance.
* The default instance's color is blue.
* Valid only for type is DataBar.
* @return {DataBar}
*/
getDataBar() {
}
/**
* Get the conditional formatting's "ColorScale" instance.
* The default instance is a "green-yellow-red" 3ColorScale .
* Valid only for type = ColorScale.
* @return {ColorScale}
*/
getColorScale() {
}
/**
* 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.
* @return {Top10}
*/
getTop10() {
}
/**
* 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.
* @return {AboveAverage}
*/
getAboveAverage() {
}
/**
* 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() {
}
/**
* The text value in a "text contains" conditional formatting rule.
* Valid only for type = containsText, notContainsText, beginsWith and endsWith.
* The default value is null.
*/
setText(value) {
}
/**
* The applicable time period in a "date occurring…" conditional formatting rule.
* Valid only for type = timePeriod.
* The default value is TimePeriodType.Today.
* The value of the property is TimePeriodType integer constant.
*/
getTimePeriod() {
}
/**
* The applicable time period in a "date occurring…" conditional formatting rule.
* Valid only for type = timePeriod.
* The default value is TimePeriodType.Today.
* The value of the property is TimePeriodType integer constant.
*/
setTimePeriod(value) {
}
/**
* Gets the value or expression associated with this format condition.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The value or expression associated with this format condition.
*/
getFormula1(isR1C1, isLocal) {
}
/**
* Gets the value or expression associated with this format condition.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The value or expression associated with this format condition.
*/
getFormula2(isR1C1, isLocal) {
}
/**
* Gets the value or expression of the conditional formatting of the cell.
* The given cell must be contained by this conditional formatting, otherwise null will be returned.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {String} The value or expression associated with the conditional formatting of the cell.
*/
getFormula1(isR1C1, isLocal, row, column) {
}
/**
* Gets the value or expression of the conditional formatting of the cell.
* The given cell must be contained by this conditional formatting, otherwise null will be returned.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {String} The value or expression associated with the conditional formatting of the cell.
*/
getFormula2(isR1C1, isLocal, row, column) {
}
/**
* Sets the value or expression associated with this format condition.
* @param {String} 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 {String} formula2 - The value or expression associated with this format condition. The input format is same with formula1
* @param {boolean} isR1C1 - Whether the formula is R1C1 formula.
* @param {boolean} isLocal - Whether the formula is locale formatted.
*/
setFormulas(formula1, formula2, isR1C1, isLocal) {
}
/**
* Sets the value or expression associated with this format condition.
* @param {String} 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 {boolean} isR1C1 - Whether the formula is R1C1 formula.
* @param {boolean} isLocal - Whether the formula is locale formatted.
*/
setFormula1(formula, isR1C1, isLocal) {
}
/**
* Sets the value or expression associated with this format condition.
* @param {String} 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 {boolean} isR1C1 - Whether the formula is R1C1 formula.
* @param {boolean} isLocal - Whether the formula is locale formatted.
*/
setFormula2(formula, isR1C1, isLocal) {
}
/**
* Gets the formula of the conditional formatting of the cell.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {String} The formula.
*/
getFormula1(row, column) {
}
/**
* Gets the formula of the conditional formatting of the cell.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {String} The formula.
*/
getFormula2(row, column) {
}
}
/**
* Represents conditional formatting.
* The FormatConditions can contain up to three conditional formats.
* @example
* //Adds an empty conditional formatting
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* var index = sheet.getConditionalFormattings().add();
* var fcs = sheet.getConditionalFormattings().get(index);
* //Sets the conditional format range.
* var ca = new aspose.cells.CellArea();
* ca.StartRow = 0;
* ca.EndRow = 0;
* ca.StartColumn = 0;
* ca.EndColumn = 0;
* fcs.addArea(ca);
* ca = new aspose.cells.CellArea();
* ca.StartRow = 1;
* ca.EndRow = 1;
* ca.StartColumn = 1;
* ca.EndColumn = 1;
* fcs.addArea(ca);
* //Adds condition.
* var conditionIndex = fcs.addCondition(aspose.cells.FormatConditionType.CELL_VALUE, aspose.cells.OperatorType.BETWEEN, "=A2", "100");
* //Adds condition.
* var conditionIndex2 = fcs.addCondition(aspose.cells.FormatConditionType.CELL_VALUE, aspose.cells.OperatorType.BETWEEN, "50", "100");
* //Sets the background color.
* var fc = fcs.get(conditionIndex);
* fc.getStyle().setBackgroundColor(aspose.cells.Color.getRed());
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class FormatConditionCollection {
/**
* Gets the count of the conditions.
*/
getCount() {
}
/**
* Gets count of conditionally formatted ranges.
*/
getRangeCount() {
}
/**
* Gets the formatting condition by index.
* @param {Number} index - the index of the formatting condition to return.
* @return {FormatCondition} the formatting condition
*/
get(index) {
}
/**
* Adds a formatting condition and effected cell rang to the FormatConditions
* The FormatConditions can contain up to three conditional formats.
* References to the other sheets are not allowed in the formulas of conditional formatting.
* OperatorType
* @param {CellArea} cellArea - Conditional formatted cell range.
* @param {Number} type - FormatConditionType
* @param {Number} operatorType - OperatorType
* @param {String} formula1 - The value or expression associated with conditional formatting.
* @param {String} formula2 - The value or expression associated with conditional formatting
* @return {Number[]} [0]:Formatting condition object index;[1] Effected cell rang index.
*/
add(cellArea, type, operatorType, formula1, formula2) {
}
/**
* Adds a conditional formatted cell range.
* @param {CellArea} cellArea - Conditional formatted cell range.
* @return {Number} Conditional formatted cell rang index.
*/
addArea(cellArea) {
}
/**
* Adds a formatting condition.
* @param {Number} type - FormatConditionType
* @param {Number} operatorType - OperatorType
* @param {String} formula1 - The value or expression associated with conditional formatting.
* 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 {String} formula2 - The value or expression associated with conditional formatting.
* The input format is same with formula1
* @return {Number} Formatting condition object index;
*/
addCondition(type, operatorType, formula1, formula2) {
}
/**
* Add a format condition.
* @param {Number} type - FormatConditionType
* @return {Number} Formatting condition object index;
*/
addCondition(type) {
}
/**
* Gets the conditional formatted cell range by index.
* @param {Number} index - the index of the conditional formatted cell range.
* @return {CellArea} the conditional formatted cell range
*/
getCellArea(index) {
}
/**
* Removes conditional formatted cell range by index.
* @param {Number} index - The index of the conditional formatted cell range to be removed.
*/
removeArea(index) {
}
/**
* Remove conditional formatting int the range.
* @param {Number} startRow - The startRow of the range.
* @param {Number} startColumn - The startColumn of the range.
* @param {Number} totalRows - The number of rows of the range.
* @param {Number} totalColumns - The number of columns of the range.
* @return {boolean}
* Returns TRUE, this FormatCondtionCollection should be removed.
*/
removeArea(startRow, startColumn, totalRows, totalColumns) {
}
/**
* Removes the formatting condition by index.
* @param {Number} index - The index of the formatting condition to be removed.
*/
removeCondition(index) {
}
}
/**
* Represents options when parsing formula.
*/
class FormulaParseOptions {
/**
*/
constructor() {
}
/**
* Whether the formula is locale formatted. Default is false.
*/
getLocaleDependent() {
}
/**
* Whether the formula is locale formatted. Default is false.
*/
setLocaleDependent(value) {
}
/**
* Whether the formula is R1C1 reference style. Default is false.
*/
getR1C1Style() {
}
/**
* Whether the formula is R1C1 reference style. Default is false.
*/
setR1C1Style(value) {
}
/**
* 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() {
}
/**
* 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).
*/
setCheckAddIn(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setParse(value) {
}
/**
* Definition for parsing custom functions.
* 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
* Workbook.updateCustomFunctionDefinition(com.aspose.cells.CustomFunctionDefinition) to get the same result.
*/
getCustomFunctionDefinition() {
}
/**
* Definition for parsing custom functions.
* 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
* Workbook.updateCustomFunctionDefinition(com.aspose.cells.CustomFunctionDefinition) to get the same result.
*/
setCustomFunctionDefinition(value) {
}
}
/**
* Settings of formulas and calculation.
* @hideconstructor
*/
class FormulaSettings {
/**
* Indicates whether the application is required to perform a full calculation when the workbook is opened.
* 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() {
}
/**
* Indicates whether the application is required to perform a full calculation when the workbook is opened.
* 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) {
}
/**
* Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
* 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() {
}
/**
* Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
* 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) {
}
/**
* Indicates whether calculates all formulas every time when a calculation is triggered.
* 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() {
}
/**
* Indicates whether calculates all formulas every time when a calculation is triggered.
* 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) {
}
/**
* Gets or sets the mode for workbook calculation in ms excel.
* The value of the property is CalcModeType integer constant.
* 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:
* Workbook.calculateFormula(), Worksheet.calculateFormula(com.aspose.cells.CalculationOptions, boolean),
* Cell.calculate(com.aspose.cells.CalculationOptions), ...etc.
*/
getCalculationMode() {
}
/**
* Gets or sets the mode for workbook calculation in ms excel.
* The value of the property is CalcModeType integer constant.
* 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:
* Workbook.calculateFormula(), Worksheet.calculateFormula(com.aspose.cells.CalculationOptions, boolean),
* Cell.calculate(com.aspose.cells.CalculationOptions), ...etc.
*/
setCalculationMode(value) {
}
/**
* Specifies the version of the calculation engine used to calculate values in the workbook.
* 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() {
}
/**
* Specifies the version of the calculation engine used to calculate values in the workbook.
* 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) {
}
/**
* Indicates whether enable iterative calculation to resolve circular references.
*/
getEnableIterativeCalculation() {
}
/**
* Indicates whether enable iterative calculation to resolve circular references.
*/
setEnableIterativeCalculation(value) {
}
/**
* The maximum iterations to resolve a circular reference.
*/
getMaxIteration() {
}
/**
* The maximum iterations to resolve a circular reference.
*/
setMaxIteration(value) {
}
/**
* The maximum change to resolve a circular reference.
*/
getMaxChange() {
}
/**
* The maximum change to resolve a circular reference.
*/
setMaxChange(value) {
}
/**
* Whether the precision of calculated result be set as they are displayed while calculating formulas
*/
getPrecisionAsDisplayed() {
}
/**
* Whether the precision of calculated result be set as they are displayed while calculating formulas
*/
setPrecisionAsDisplayed(value) {
}
/**
* Whether enable calculation chain for formulas. Default is false.
* 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() {
}
/**
* Whether enable calculation chain for formulas. Default is false.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* 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() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* 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) {
}
}
/**
* 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.
* @hideconstructor
*/
class FractionEquationNode {
/**
* This specifies the type of fraction ; the default is 'Bar'.
* The value of the property is EquationFractionType integer constant.
*/
getFractionType() {
}
/**
* This specifies the type of fraction ; the default is 'Bar'.
* The value of the property is EquationFractionType integer constant.
*/
setFractionType(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* 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.
* @hideconstructor
*/
class FunctionEquationNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents a geometric shape.
* @hideconstructor
*/
class Geometry {
/**
* Gets a collection of shape adjust value
*/
getShapeAdjustValues() {
}
}
/**
* Represents the globalization settings.
*/
class GlobalizationSettings {
/**
*/
constructor() {
}
/**
* Gets or sets the globalization settings for Chart.
*/
getChartSettings() {
}
/**
* Gets or sets the globalization settings for Chart.
*/
setChartSettings(value) {
}
/**
* Gets or sets the globalization settings for pivot table.
*/
getPivotSettings() {
}
/**
* Gets or sets the globalization settings for pivot table.
*/
setPivotSettings(value) {
}
/**
* Gets the separator for list, parameters of function, ...etc.
*/
getListSeparator() {
}
/**
* Gets the separator for rows in array data in formula.
*/
getRowSeparatorOfFormulaArray() {
}
/**
* Gets the separator for the items in array's row data in formula.
*/
getColumnSeparatorOfFormulaArray() {
}
/**
* Gets the name of "Total" label in the PivotTable.
* You need to override this method when the PivotTable contains two or more PivotFields in the data area.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "Total" label
*/
getPivotTotalName() {
}
/**
* Gets the name of "Grand Total" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "Grand Total" label
*/
getPivotGrandTotalName() {
}
/**
* Gets the name of "(Multiple Items)" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "(Multiple Items)" label
*/
getMultipleItemsName() {
}
/**
* Gets the name of "(All)" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use GlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "(All)" label
*/
getAllName() {
}
/**
* Gets the protection name in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetTextOfProtectedName(string) method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The protection name of PivotTable
*/
getProtectionNameOfPivotTable() {
}
/**
* Gets the name of "Column Labels" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of column labels
*/
getColumnLabelsOfPivotTable() {
}
/**
* Gets the name of "Row Labels" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of row labels
*/
getRowLabelsNameOfPivotTable() {
}
/**
* Gets the name of "(blank)" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of empty data
*/
getEmptyDataName() {
}
/**
* Gets the the name of the value area field header in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of data field header name
*/
getDataFieldHeaderNameOfPivotTable() {
}
/**
* Gets the name of PivotFieldSubtotalType type in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} subTotalType - PivotFieldSubtotalType
* @return {String} The name of PivotFieldSubtotalType type
*/
getSubTotalName(subTotalType) {
}
/**
* Gets the total name of the function.
* @param {Number} functionType - ConsolidationFunction
* @return {String} The total name of the function.
*/
getTotalName(functionType) {
}
/**
* Gets the grand total name of the function.
* @param {Number} functionType - ConsolidationFunction
* @return {String} The grand total name of the function.
*/
getGrandTotalName(functionType) {
}
/**
* Gets the default sheet name for adding worksheet automatically.
* Default is "Sheet".
* The automatically added(such as by WorksheetCollection.add())
* 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".@return {String} the default sheet name for adding worksheet automatically
*/
getDefaultSheetName() {
}
/**
* Gets the type name of table rows that consists of the table header.
* Default is "Headers", so in formula "#Headers" represents the table header.
* @return {String} the type name of table rows
*/
getTableRowTypeOfHeaders() {
}
/**
* 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.
* @return {String} the type name of table rows
*/
getTableRowTypeOfData() {
}
/**
* 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.
* @return {String} the type name of table rows
*/
getTableRowTypeOfAll() {
}
/**
* 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.
* @return {String} the type name of table rows
*/
getTableRowTypeOfTotals() {
}
/**
* 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.
* @return {String} the type name of table rows
*/
getTableRowTypeOfCurrent() {
}
/**
* Gets the display string value for cell's error value
* @param {String} err - error values such as #VALUE!,#NAME?
* @return {String} By default returns the error value itself
*/
getErrorValueString(err) {
}
/**
* Gets the display string value for cell's boolean value
* @param {boolean} bv - boolean value
* @return {String} By default returns "TRUE" for true value and "FALSE" for false value.
*/
getBooleanValueString(bv) {
}
/**
* Gets the locale dependent function name according to given standard function name.
* @param {String} standardName - Standard(en-US locale) function name.
* @return {String} Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
*/
getLocalFunctionName(standardName) {
}
/**
* Gets the standard function name according to given locale dependent function name.
* @param {String} localName - Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
* @return {String} Standard(en-US locale) function name.
*/
getStandardFunctionName(localName) {
}
/**
* Gets the locale dependent text for built-in Name according to given standard text.
* @param {String} standardName - Standard(en-US locale) text of built-in Name.
* @return {String} Locale dependent text. The locale was specified by the Workbook for which this settings is used.
*/
getLocalBuiltInName(standardName) {
}
/**
* Gets the standard text of built-in Name according to given locale dependent text.
* @param {String} localName - Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used.
* @return {String} Standard(en-US locale) text.
*/
getStandardBuiltInName(localName) {
}
/**
* Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
* @param {String} localfontStyleName - Locale font style name for Header/Footer.
* @return {String} Standard English font style name(Regular, Bold, Italic)
*/
getStandardHeaderFooterFontStyleName(localfontStyleName) {
}
/**
* Gets the locale dependent comment title name according to comment title type.
* @param {Number} type - CommentTitleType
* @return {String}
*/
getCommentTitleName(type) {
}
/**
* Compares two string values according to certain collation rules.
* @param {String} v1 - the first string
* @param {String} v2 - the second string
* @param {boolean} ignoreCase - whether ignore case when comparing values
* @return {Number} Integer that indicates the lexical relationship between the two comparands
*/
compare(v1, v2, ignoreCase) {
}
/**
* Transforms the string into a comparable object according to certain collation rules.
* @param {String} v - String value needs to be compared with others.
* @param {boolean} ignoreCase - whether ignore case when comparing values
* @return {IComparable} Object can be used to compare or sort string values
*/
getCollationKey(v, ignoreCase) {
}
}
/**
* This class specifies a glow effect, in which a color blurred outline
* is added outside the edges of the object.
* @hideconstructor
*/
class GlowEffect {
/**
* Gets the color of the glow effect.
*/
getColor() {
}
/**
* Gets the color of the glow effect.
*/
setColor(value) {
}
/**
* Gets and sets the radius of the glow, in unit of points.
* NOTE: This member is now obsolete. Instead,
* please use GlowEffect.Size property.
* This property will be removed 6 months later since September 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getRadius() {
}
/**
* Gets and sets the radius of the glow, in unit of points.
* NOTE: This member is now obsolete. Instead,
* please use GlowEffect.Size property.
* This property will be removed 6 months later since September 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setRadius(value) {
}
/**
* Gets and sets the radius of the glow, in unit of points.
*/
getSize() {
}
/**
* Gets and sets the radius of the glow, in unit of points.
*/
setSize(value) {
}
/**
* Gets and sets the degree of transparency of the glow effect. Range from 0.0 (opaque) to 1.0 (clear).
*/
getTransparency() {
}
/**
* Gets and sets the degree of transparency of the glow effect. Range from 0.0 (opaque) to 1.0 (clear).
*/
setTransparency(value) {
}
}
/**
* Represents the gradient fill.
* @hideconstructor
*/
class GradientFill {
/**
* Represents the gradient stop collection.
*/
getGradientStops() {
}
/**
* Gets the gradient fill type.
* The value of the property is GradientFillType integer constant.
*/
getFillType() {
}
/**
* Gets the gradient direction type.
* The value of the property is GradientDirectionType integer constant.
*/
getDirectionType() {
}
/**
* The angle of linear fill.
*/
getAngle() {
}
/**
* The angle of linear fill.
*/
setAngle(value) {
}
/**
* Gets gradient color 1. Applies to Excel97-2003
*/
getGradientColor1() {
}
/**
* Gets gradient color 2. Applies to Excel97-2003
*/
getGradientColor2() {
}
/**
* Gets gradient degree. Applies to Excel97-2003
*/
getGradientDegree() {
}
/**
* Gets gradient color type. Applies to Excel97-2003
* The value of the property is GradientColorType integer constant.
*/
getGradientColorType() {
}
/**
* Returns the gradient preset color for the specified fill. Applies to Excel97-2003
* The value of the property is GradientPresetType integer constant.
*/
getPresetColor() {
}
/**
* Returns the gradient preset color for the specified fill. Applies to Excel97-2003
* The value of the property is GradientPresetType integer constant.
*/
setPresetColor(value) {
}
/**
* Gets variant. Applies to Excel97-2003
*/
getVariant() {
}
/**
* Gets gradient style type. Applies to Excel97-2003
* The value of the property is GradientStyleType integer constant.
*/
getGradientStyle() {
}
/**
* Set the gradient fill type and direction.
* @param {Number} type - GradientFillType
* @param {Number} angle - The angle. Only applies for GradientFillType.Linear.
* @param {Number} direction - GradientDirectionType
*/
setGradient(type, angle, direction) {
}
/**
* Sets preset theme gradient fill.
* @param {Number} gradientType - PresetThemeGradientType
* @param {Number} themeColorType - ThemeColorType
*/
setPresetThemeGradient(gradientType, themeColorType) {
}
/**
* Sets the specified fill to a preset-color gradient.
* Only applies for Excel 97-2003
* @param {Number} presetColor - GradientPresetType
* @param {Number} style - GradientStyleType
* @param {Number} 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, style, variant) {
}
/**
* Sets the specified fill to a one-color gradient.
* Only applies for Excel 2007.
* @param {Color} color - One gradient color.
* @param {Number} degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).
* @param {Number} style - GradientStyleType
* @param {Number} 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, degree, style, variant) {
}
/**
* Sets the specified fill to a two-color gradient.
* Only applies for Excel 2007.
* @param {Color} color1 - One gradient color.
* @param {Color} color2 - Two gradient color.
* @param {Number} style - GradientStyleType
* @param {Number} 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, color2, style, variant) {
}
/**
* Sets the specified fill to a two-color gradient.
* Only applies for Excel 2007.
* @param {Color} color1 - One gradient color.
* @param {Number} transparency1 - The degree of transparency of the color1 as a value from 0.0 (opaque) through 1.0 (clear).
* @param {Color} color2 - Two gradient color.
* @param {Number} transparency2 - The degree of transparency of the color2 as a value from 0.0 (opaque) through 1.0 (clear).
* @param {Number} style - GradientStyleType
* @param {Number} 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, transparency1, color2, transparency2, style, variant) {
}
/**
* /
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* Represents the gradient stop.
* @hideconstructor
*/
class GradientStop {
/**
* The position of the stop.
*/
getPosition() {
}
/**
* The position of the stop.
*/
setPosition(value) {
}
/**
* Gets the color of this gradient stop.
*/
getCellsColor() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
}
/**
* Represents the gradient stop collection.
* @hideconstructor
*/
class GradientStopCollection {
/**
*/
getCount() {
}
/**
* Gets the gradient stop by the index.
* @param {Number} index - The index.
* @return {GradientStop} The gradient stop.
*/
get(index) {
}
/**
* Gets the gradient stop by the index.
* @param {Number} index - The index.
* @return {GradientStop} The gradient stop.
*/
set(index, value) {
}
/**
* Add a gradient stop.
* @param {Number} position - The position of the stop,in unit of percentage.
* @param {CellsColor} color - The color of the stop.
* @param {Number} alpha - The alpha of the color.
*/
add(position, color, alpha) {
}
/**
* Add a gradient stop.
* @param {Number} position - The position of the stop,in unit of percentage.
* @param {Color} color - The color of the stop.
* @param {Number} alpha - The alpha of the color.
*/
add(position, color, alpha) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Encapsulates the object that represents a groupbox in a spreadsheet.
* @example
* //Instantiate a new Workbook.
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var java = require("java");
* var excelbook = new aspose.cells.Workbook();
* //Add a group box to the first worksheet.
* var box = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.GROUP_BOX, 1, 0, 1, 0, 300, 250);
* //Set the caption of the group box.
* box.setText("Age Groups");
* box.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Make it 2-D box.
* box.setShadow(false);
* //Add a radio button.
* var radio1 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.RADIO_BUTTON, 3, 0, 2, 0, 30, 110);
* //Set its text string.
* radio1.setText("20-29");
* //Set A1 cell as a linked cell for the radio button.
* radio1.setLinkedCell("A1");
* //Make the radio button 3-D.
* radio1.setShadow(true);
* //Set the foreground color of the radio button.
* radio1.getFillFormat().setForeColor(aspose.cells.Color.getLightGreen());
* //Set the line style of the radio button.
* radio1.getLineFormat().setStyle(aspose.cells.MsoLineStyle.THICK_THIN);
* //Set the weight of the radio button.
* radio1.getLineFormat().setWeight(4);
* //Set the line color of the radio button.
* radio1.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the radio button.
* radio1.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Make the line format visible.
* radio1.getLineFormat().setVisible(true);
* //Make the fill format visible.
* radio1.getFillFormat().setVisible(true);
* //Add another radio button.
* var radio2 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.RADIO_BUTTON, 6, 0, 2, 0, 30, 110);
* //Set its text string.
* radio2.setText("30-39");
* //Set A1 cell as a linked cell for the radio button.
* radio2.setLinkedCell("A1");
* //Make the radio button 3-D.
* radio2.setShadow(true);
* //Set the foreground color of the radio button.
* radio2.getFillFormat().setForeColor(aspose.cells.Color.getLightGreen());
* //Set the line style of the radio button.
* radio2.getLineFormat().setStyle(aspose.cells.MsoLineStyle.THICK_THIN);
* //Set the weight of the radio button.
* radio2.getLineFormat().setWeight(4);
* //Set the line color of the radio button.
* radio2.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the radio button.
* radio2.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Make the line format visible.
* radio2.getLineFormat().setVisible(true);
* //Make the fill format visible.
* radio2.getFillFormat().setVisible(true);
* //Add another radio button.
* var radio3 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.RADIO_BUTTON, 9, 0, 2, 0, 30, 110);
* //Set its text string.
* radio3.setText("40-49");
* //Set A1 cell as a linked cell for the radio button.
* radio3.setLinkedCell("A1");
* //Make the radio button 3-D.
* radio3.setShadow(true);
* //Set the foreground color of the radio button.
* radio3.getFillFormat().setForeColor(aspose.cells.Color.getLightGreen());
* //Set the line style of the radio button.
* radio3.getLineFormat().setStyle(aspose.cells.MsoLineStyle.THICK_THIN);
* //Set the weight of the radio button.
* radio3.getLineFormat().setWeight(4);
* //Set the line color of the radio button.
* radio3.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the radio button.
* radio3.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Make the line format visible.
* radio3.getLineFormat().setVisible(true);
* //Make the fill format visible.
* radio3.getFillFormat().setVisible(true);
* //Get the shapes.
* var shapeobjects = [ box, radio1, radio2, radio3 ];
* var javaShapeObjects = java.newArray("com.aspose.cells.Shape", shapeobjects);
* //Group the shapes.
* var group = excelbook.getWorksheets().get(0).getShapes().group(javaShapeObjects);
* //Save the excel file.
* excelbook.save("Book1.xls");
* @hideconstructor
*/
class GroupBox {
/**
* Indicates whether the groupbox has shadow.
*/
getShadow() {
}
/**
* Indicates whether the groupbox has shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* This class specifies the Group-Character function, consisting of a character drawn above or below text, often with the purpose of visually grouping items.
* @hideconstructor
*/
class GroupCharacterEquationNode {
/**
* 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.
* 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() {
}
/**
* 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.
* 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) {
}
/**
* Specify combining characters by type value.
* The value of the property is EquationCombiningCharacterType integer constant.
*/
getChrType() {
}
/**
* Specify combining characters by type value.
* The value of the property is EquationCombiningCharacterType integer constant.
*/
setChrType(value) {
}
/**
* This attribute specifies the position of the character in the object
* The value of the property is EquationCharacterPositionType integer constant.
*/
getPosition() {
}
/**
* This attribute specifies the position of the character in the object
* The value of the property is EquationCharacterPositionType integer constant.
*/
setPosition(value) {
}
/**
* 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.
* The value of the property is EquationCharacterPositionType integer constant.
*/
getVertJc() {
}
/**
* 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.
* The value of the property is EquationCharacterPositionType integer constant.
*/
setVertJc(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents this fill format should inherit the fill properties of the group.
* @hideconstructor
*/
class GroupFill {
/**
* /
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* Represents the group shape which contains the individual shapes.
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var java = require("java");
* //Instantiate a new Workbook.
* var excelbook = new aspose.cells.Workbook();
* //Add a group box to the first worksheet.
* var box = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.GROUP_BOX, 1, 0, 1, 0, 300, 250);
* //Set the caption of the group box.
* box.setText("Age Groups");
* box.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Make it 2-D box.
* box.setShadow(false);
* //Add a radio button.
* var radio1 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.RADIO_BUTTON, 3, 0, 2, 0, 30, 110);
* //Set its text string.
* radio1.setText("20-29");
* //Set A1 cell as a linked cell for the radio button.
* radio1.setLinkedCell("A1");
* //Make the radio button 3-D.
* radio1.setShadow(true);
* //Set the foreground color of the radio button.
* radio1.getFillFormat().setForeColor(aspose.cells.Color.getLightGreen());
* //Set the line style of the radio button.
* radio1.getLineFormat().setStyle(aspose.cells.MsoLineStyle.THICK_THIN);
* //Set the weight of the radio button.
* radio1.getLineFormat().setWeight(4);
* //Set the line color of the radio button.
* radio1.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the radio button.
* radio1.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Make the line format visible.
* radio1.getLineFormat().setVisible(true);
* //Make the fill format visible.
* radio1.getFillFormat().setVisible(true);
* //Add another radio button.
* var radio2 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.RADIO_BUTTON, 6, 0, 2, 0, 30, 110);
* //Set its text string.
* radio2.setText("30-39");
* //Set A1 cell as a linked cell for the radio button.
* radio2.setLinkedCell("A1");
* //Make the radio button 3-D.
* radio2.setShadow(true);
* //Set the foreground color of the radio button.
* radio2.getFillFormat().setForeColor(aspose.cells.Color.getLightGreen());
* //Set the line style of the radio button.
* radio2.getLineFormat().setStyle(aspose.cells.MsoLineStyle.THICK_THIN);
* //Set the weight of the radio button.
* radio2.getLineFormat().setWeight(4);
* //Set the line color of the radio button.
* radio2.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the radio button.
* radio2.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Make the line format visible.
* radio2.getLineFormat().setVisible(true);
* //Make the fill format visible.
* radio2.getFillFormat().setVisible(true);
* //Add another radio button.
* var radio3 = excelbook.getWorksheets().get(0).getShapes().addShape(aspose.cells.MsoDrawingType.RADIO_BUTTON, 9, 0, 2, 0, 30, 110);
* //Set its text string.
* radio3.setText("40-49");
* //Set A1 cell as a linked cell for the radio button.
* radio3.setLinkedCell("A1");
* //Make the radio button 3-D.
* radio3.setShadow(true);
* //Set the foreground color of the radio button.
* radio3.getFillFormat().setForeColor(aspose.cells.Color.getLightGreen());
* //Set the line style of the radio button.
* radio3.getLineFormat().setStyle(aspose.cells.MsoLineStyle.THICK_THIN);
* //Set the weight of the radio button.
* radio3.getLineFormat().setWeight(4);
* //Set the line color of the radio button.
* radio3.getLineFormat().setForeColor(aspose.cells.Color.getBlue());
* //Set the dash style of the radio button.
* radio3.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Make the line format visible.
* radio3.getLineFormat().setVisible(true);
* //Make the fill format visible.
* radio3.getFillFormat().setVisible(true);
* //Get the shapes.
* var shapeobjects = [ box, radio1, radio2, radio3 ];
* var javaShapeObjects = java.newArray("com.aspose.cells.Shape", shapeobjects);
* //Group the shapes.
* var group = excelbook.getWorksheets().get(0).getShapes().group(javaShapeObjects);
* //Save the excel file.
* excelbook.save("Book1.xls");
* @hideconstructor
*/
class GroupShape {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the child shape by index.
* @param {Number} index - the child shape index.
* @return {Shape} return the child shape.
*/
get(index) {
}
/**
* Ungroups the shape items.
* If the group shape is grouped by another group shape,nothing will be done.
*/
ungroup() {
}
/**
* Gets the shapes grouped by this shape.
*/
getGroupedShapes() {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents the command of header/footer
* @hideconstructor
*/
class HeaderFooterCommand {
/**
* Gets the header/footer' command type .
* The value of the property is HeaderFooterCommandType integer constant.
*/
getType() {
}
/**
* Gets the font of the command's value.
* Useless for HeaderFooterCommandType.Picture.
*/
getFont() {
}
/**
* Gets the text of the command.
* Only valid for HeaderFooterCommandType.Text.
*/
getText() {
}
}
/**
* Represents options of highlighting revsions or changes of shared Excel files.
*/
class HighlightChangesOptions {
/**
* Represents options of highlighting revsions or changes of shared Excel files.
* @param {boolean} highlightOnScreen -
* Indicates whether highlighting changes on screen.
* @param {boolean} listOnNewSheet -
* Indicates whether listing changes on a new worksheet.
*/
constructor(highlightOnScreen, listOnNewSheet) {
}
}
/**
* Encapsulates the object that represents a horizontal page break.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(0);
* //Add a page break at cell Y30
* var Index = worksheet.getHorizontalPageBreaks().add("Y30");
* //get the newly added horizontal page break
* var hPageBreak = worksheet.getHorizontalPageBreaks().get(Index);
* @hideconstructor
*/
class HorizontalPageBreak {
/**
* Gets the start column index of this horizontal page break.
*/
getStartColumn() {
}
/**
* Gets the end column index of this horizontal page break.
*/
getEndColumn() {
}
/**
* Gets the zero based row index.
*/
getRow() {
}
}
/**
* Encapsulates a collection of HorizontalPageBreak objects.
* @example
* //Add a pagebreak at G5
* excel.getWorksheets().get(0).getHorizontalPageBreaks().add("G5");
* excel.getWorksheets().get(0).getVerticalPageBreaks().add("G5");
* @hideconstructor
*/
class HorizontalPageBreakCollection {
/**
*/
getCount() {
}
/**
* Gets the HorizontalPageBreak element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {HorizontalPageBreak} The element at the specified index.
*/
get(index) {
}
/**
* Gets the HorizontalPageBreak element with the specified cell name.
* @param {String} cellName - Cell name.
* @return {HorizontalPageBreak} The element with the specified cell name.
*/
get(cellName) {
}
/**
* Adds a horizontal page break to the collection.
* This method is used to add a horizontal pagebreak within a print area.
* @param {Number} row - Row index, zero based.
* @param {Number} startColumn - Start column index, zero based.
* @param {Number} endColumn - End column index, zero based.
* @return {Number} HorizontalPageBreak object index.
*/
add(row, startColumn, endColumn) {
}
/**
* Adds a horizontal page break to the collection.
* Page break is added in the top left of the cell.
* Please set a horizontal page break and a vertical page break concurrently.
* @param {Number} row - Cell row index, zero based.
* @return {Number} HorizontalPageBreak object index.
*/
add(row) {
}
/**
* Adds a horizontal page break to the collection.
* Page break is added in the top left of the cell.
* Please set a horizontal page break and a vertical page break concurrently.
* @param {Number} row - Cell row index, zero based.
* @param {Number} column - Cell column index, zero based.
* @return {Number} HorizontalPageBreak object index.
*/
add(row, column) {
}
/**
* Adds a horizontal page break to the collection.
* Page break is added in the top left of the cell.
* Please set a horizontal page break and a vertical page break concurrently.
* @param {String} cellName - Cell name.
* @return {Number} HorizontalPageBreak object index.
*/
add(cellName) {
}
/**
* Removes the HPageBreak element at a specified name.
* @param {Number} index - Element index, zero based.
*/
removeAt(index) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents options when importing a html file.
*/
class HtmlLoadOptions {
/**
* Creates an options of loading the file.
*/
constructor() {
}
/**
* Creates an options of loading the file.
* @param {Number} loadFormat - LoadFormat
*/
constructor_overload$1(loadFormat) {
}
/**
* The directory that the attached files will be saved to.
* NOTE: This member is now obsolete. Instead,
* please use HtmlLoadOptions.StreamProvider property.
* This property will be removed 12 months later since December 2014.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getAttachedFilesDirectory() {
}
/**
* The directory that the attached files will be saved to.
* NOTE: This member is now obsolete. Instead,
* please use HtmlLoadOptions.StreamProvider property.
* This property will be removed 12 months later since December 2014.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setAttachedFilesDirectory(value) {
}
/**
* Indicates whether importing formulas if the original html file contains formulas
*/
getLoadFormulas() {
}
/**
* Indicates whether importing formulas if the original html file contains formulas
*/
setLoadFormulas(value) {
}
/**
* Indicates whether support the layout of <div> tag when the html file contains it.
* The default value is false.
*/
getSupportDivTag() {
}
/**
* Indicates whether support the layout of <div> tag when the html file contains it.
* The default value is false.
*/
setSupportDivTag(value) {
}
/**
* Indicates whether delete redundant spaces when the text wraps lines using <br> tag.
* The default value is false.
*/
getDeleteRedundantSpaces() {
}
/**
* Indicates whether delete redundant spaces when the text wraps lines using <br> tag.
* The default value is false.
*/
setDeleteRedundantSpaces(value) {
}
/**
* Indicates whether auto-fit columns and rows. The default value is false.
*/
getAutoFitColsAndRows() {
}
/**
* Indicates whether auto-fit columns and rows. The default value is false.
*/
setAutoFitColsAndRows(value) {
}
/**
* if true, convert string to formula when string value starts with character '=',the default value is false.
* NOTE: This property is now obsolete.
* Instead, please use HtmlLoadOptions.HasFormula property.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getConvertFormulasData() {
}
/**
* if true, convert string to formula when string value starts with character '=',the default value is false.
* NOTE: This property is now obsolete.
* Instead, please use HtmlLoadOptions.HasFormula property.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setConvertFormulasData(value) {
}
/**
* Indicates whether the text is formula if it starts with "=".
*/
hasFormula() {
}
/**
* Indicates whether the text is formula if it starts with "=".
*/
setHasFormula(value) {
}
/**
* Gets the program id of creating the file.
* Only for MHT files.
*/
getProgId() {
}
/**
* Get the HtmlTableLoadOptionCollection instance
*/
getTableLoadOptions() {
}
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
getEncoding() {
}
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
setEncoding(value) {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
getLoadStyleStrategy() {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
setLoadStyleStrategy(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
getConvertNumericData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
setConvertNumericData(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
getConvertDateTimeData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
setConvertDateTimeData(value) {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
getKeepPrecision() {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
setKeepPrecision(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents the options for saving html file.
*/
class HtmlSaveOptions {
/**
* Creates options for saving html file.
*/
constructor() {
}
/**
* Creates options for saving htm file.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Indicate whether exporting those not visible shapes
* The default values is false.
*/
getIgnoreInvisibleShapes() {
}
/**
* Indicate whether exporting those not visible shapes
* The default values is false.
*/
setIgnoreInvisibleShapes(value) {
}
/**
* The title of the html page.
* Only for saving to html stream.
*/
getPageTitle() {
}
/**
* The title of the html page.
* Only for saving to html stream.
*/
setPageTitle(value) {
}
/**
* The directory that the attached files will be saved to.
* Only for saving to html stream.
*/
getAttachedFilesDirectory() {
}
/**
* The directory that the attached files will be saved to.
* Only for saving to html stream.
*/
setAttachedFilesDirectory(value) {
}
/**
* Specify the Url prefix of attached files such as image in the html file.
* Only for saving to html stream.
*/
getAttachedFilesUrlPrefix() {
}
/**
* Specify the Url prefix of attached files such as image in the html file.
* Only for saving to html stream.
*/
setAttachedFilesUrlPrefix(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDefaultFontName(value) {
}
/**
* Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
*/
getWorksheetScalable() {
}
/**
* Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
*/
setWorksheetScalable(value) {
}
/**
* Indicates if exporting comments when saving file to html, the default value is false.
*/
isExportComments() {
}
/**
* Indicates if exporting comments when saving file to html, the default value is false.
*/
setExportComments(value) {
}
/**
* Represents type of exporting comments to html files.
* The value of the property is PrintCommentsType integer constant.
*/
getExportCommentsType() {
}
/**
* Represents type of exporting comments to html files.
* The value of the property is PrintCommentsType integer constant.
*/
setExportCommentsType(value) {
}
/**
* Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
*/
getDisableDownlevelRevealedComments() {
}
/**
* Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
*/
setDisableDownlevelRevealedComments(value) {
}
/**
* Indicates whether exporting image files to temp directory.
* Only for saving to html stream.
*/
isExpImageToTempDir() {
}
/**
* Indicates whether exporting image files to temp directory.
* Only for saving to html stream.
*/
setExpImageToTempDir(value) {
}
/**
* 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() {
}
/**
* Indicates whether using scalable unit to describe the image width
* when using scalable unit to describe the column width.
* The default value is true.
*/
setImageScalable(value) {
}
/**
* Indicates whether exporting column width in unit of scale to html.
* The default value is false.
*/
getWidthScalable() {
}
/**
* Indicates whether exporting column width in unit of scale to html.
* The default value is false.
*/
setWidthScalable(value) {
}
/**
* Indicates whether exporting the single tab when the file only has one worksheet.
* The default value is false.
*/
getExportSingleTab() {
}
/**
* Indicates whether exporting the single tab when the file only has one worksheet.
* The default value is false.
*/
setExportSingleTab(value) {
}
/**
* Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
* When this property is set to true image data is exported directly on the
* img elements and separate files are not created.
*/
getExportImagesAsBase64() {
}
/**
* Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
* When this property is set to true image data is exported directly on the
* img elements and separate files are not created.
*/
setExportImagesAsBase64(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportActiveWorksheetOnly(value) {
}
/**
* Indicates if only exporting the print area to html file. The default value is false.
*/
getExportPrintAreaOnly() {
}
/**
* Indicates if only exporting the print area to html file. The default value is false.
*/
setExportPrintAreaOnly(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportArea(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setParseHtmlTagInCell(value) {
}
/**
* 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.
* The value of the property is HtmlCrossType integer constant.
*/
getHtmlCrossStringType() {
}
/**
* 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.
* The value of the property is HtmlCrossType integer constant.
*/
setHtmlCrossStringType(value) {
}
/**
* 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"
* The value of the property is HtmlHiddenColDisplayType integer constant.
*/
getHiddenColDisplayType() {
}
/**
* 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"
* The value of the property is HtmlHiddenColDisplayType integer constant.
*/
setHiddenColDisplayType(value) {
}
/**
* 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"
* The value of the property is HtmlHiddenRowDisplayType integer constant.
*/
getHiddenRowDisplayType() {
}
/**
* 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"
* The value of the property is HtmlHiddenRowDisplayType integer constant.
*/
setHiddenRowDisplayType(value) {
}
/**
* If not set,use Encoding.UTF8 as default enconding type.
*/
getEncoding() {
}
/**
* If not set,use Encoding.UTF8 as default enconding type.
*/
setEncoding(value) {
}
/**
* Gets or sets the ExportObjectListener for exporting objects.
* NOTE: This property is now obsolete. Instead,
* please use HtmlSaveOptions.IStreamProvider property.
* This property will be removed 12 months later since August 2015.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getExportObjectListener() {
}
/**
* Gets or sets the ExportObjectListener for exporting objects.
* NOTE: This property is now obsolete. Instead,
* please use HtmlSaveOptions.IStreamProvider property.
* This property will be removed 12 months later since August 2015.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setExportObjectListener(value) {
}
/**
* Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
*/
getFilePathProvider() {
}
/**
* Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
*/
setFilePathProvider(value) {
}
/**
* Get the ImageOrPrintOptions object before exporting
*/
getImageOptions() {
}
/**
* Indicates whether save the html as single file.
* The default value is false.
* 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() {
}
/**
* Indicates whether save the html as single file.
* The default value is false.
* 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) {
}
/**
* Indicates whether showing all sheets when saving as a single html file.
* Only works when SaveAsSingleFile is True.
*/
getShowAllSheets() {
}
/**
* Indicates whether showing all sheets when saving as a single html file.
* Only works when SaveAsSingleFile is True.
*/
setShowAllSheets(value) {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
getExportPageHeaders() {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
setExportPageHeaders(value) {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
getExportPageFooters() {
}
/**
* Indicates whether exporting page headers.
* Only works when SaveAsSingleFile is True.
*/
setExportPageFooters(value) {
}
/**
* Indicating if exporting the hidden worksheet content.The default value is true.
*/
getExportHiddenWorksheet() {
}
/**
* Indicating if exporting the hidden worksheet content.The default value is true.
*/
setExportHiddenWorksheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setPresentationPreference(value) {
}
/**
* Gets and sets the prefix of the css name,the default value is "".
*/
getCellCssPrefix() {
}
/**
* Gets and sets the prefix of the css name,the default value is "".
*/
setCellCssPrefix(value) {
}
/**
* 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() {
}
/**
* 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 "".
*/
setTableCssId(value) {
}
/**
* Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
* The default value is false.
*/
isFullPathLink() {
}
/**
* Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
* The default value is false.
*/
setFullPathLink(value) {
}
/**
* Indicating whether export the worksheet css separately.The default value is false.
*/
getExportWorksheetCSSSeparately() {
}
/**
* Indicating whether export the worksheet css separately.The default value is false.
*/
setExportWorksheetCSSSeparately(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportSimilarBorderStyle(value) {
}
/**
* 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.
*/
getMergeEmptyTdForcely() {
}
/**
* 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.
*/
setMergeEmptyTdForcely(value) {
}
/**
* The option to merge contiguous empty cells(empty td elements)
* The default value is MergeEmptyTdType.Default.
* The value of the property is MergeEmptyTdType integer constant.
*/
getMergeEmptyTdType() {
}
/**
* The option to merge contiguous empty cells(empty td elements)
* The default value is MergeEmptyTdType.Default.
* The value of the property is MergeEmptyTdType integer constant.
*/
setMergeEmptyTdType(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportCellCoordinate(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportExtraHeadings(value) {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* NOTE: This member is now obsolete. Instead,
* please use HtmlSaveOptions.ExportRowColumnHeadings property.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getExportHeadings() {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* NOTE: This member is now obsolete. Instead,
* please use HtmlSaveOptions.ExportRowColumnHeadings property.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setExportHeadings(value) {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* The default value is false.
*/
getExportRowColumnHeadings() {
}
/**
* Indicates whether exports sheet's row and column headings when saving to HTML files.
* The default value is false.
*/
setExportRowColumnHeadings(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportFormula(value) {
}
/**
* Indicates whether adding tooltip text when the data can't be fully displayed.
* The default value is false.
*/
getAddTooltipText() {
}
/**
* Indicates whether adding tooltip text when the data can't be fully displayed.
* The default value is false.
*/
setAddTooltipText(value) {
}
/**
* Indicating whether exporting the gridlines.The default value is false.
*/
getExportGridLines() {
}
/**
* Indicating whether exporting the gridlines.The default value is false.
*/
setExportGridLines(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportBogusRowData(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExcludeUnusedStyles(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportDocumentProperties(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportWorksheetProperties(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportWorkbookProperties(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setExportFrameScriptsAndProperties(value) {
}
/**
* Indicating the rule of exporting html file data.The default value is All.
* The value of the property is HtmlExportDataOptions integer constant.
*/
getExportDataOptions() {
}
/**
* Indicating the rule of exporting html file data.The default value is All.
* The value of the property is HtmlExportDataOptions integer constant.
*/
setExportDataOptions(value) {
}
/**
* Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
* The value of the property is HtmlLinkTargetType integer constant.
*/
getLinkTargetType() {
}
/**
* Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
* The value of the property is HtmlLinkTargetType integer constant.
*/
setLinkTargetType(value) {
}
/**
* Indicating whether the output HTML is compatible with IE browser.
* The defalut value is false
*/
isIECompatible() {
}
/**
* Indicating whether the output HTML is compatible with IE browser.
* The defalut value is false
*/
setIECompatible(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setFormatDataIgnoreColumnWidth(value) {
}
/**
* Indicates whether to calculate formulas before saving html file.
* The default value is false.
*/
getCalculateFormula() {
}
/**
* Indicates whether to calculate formulas before saving html file.
* The default value is false.
*/
setCalculateFormula(value) {
}
/**
* Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
* The default value is true.
*/
isJsBrowserCompatible() {
}
/**
* Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
* The default value is true.
*/
setJsBrowserCompatible(value) {
}
/**
* Indicates whether the output HTML is compatible with mobile devices.
* The default value is false.
*/
isMobileCompatible() {
}
/**
* Indicates whether the output HTML is compatible with mobile devices.
* The default value is false.
*/
setMobileCompatible(value) {
}
/**
* Gets or sets the additional css styles for the formatter.
* Only works when SaveAsSingleFile is True.
* Example:
* CssStyles="body { padding: 5px }";
*/
getCssStyles() {
}
/**
* Gets or sets the additional css styles for the formatter.
* Only works when SaveAsSingleFile is True.
* Example:
* CssStyles="body { padding: 5px }";
*/
setCssStyles(value) {
}
/**
* Indicates whether to hide overflow text when the cell format is set to wrap text.
* The default value is false
*/
getHideOverflowWrappedText() {
}
/**
* Indicates whether to hide overflow text when the cell format is set to wrap text.
* The default value is false
*/
setHideOverflowWrappedText(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents the option when import table from html.
*/
class HtmlTableLoadOption {
/**
*/
constructor() {
}
/**
* Get or set the index of table to import from html.
*/
getTableIndex() {
}
/**
* Get or set the index of table to import from html.
*/
setTableIndex(value) {
}
/**
* Get or set the id of table to import from html
*/
getId() {
}
/**
* Get or set the id of table to import from html
*/
setId(value) {
}
/**
* Get or set the name of table to import from html
*/
getName() {
}
/**
* Get or set the name of table to import from html
*/
setName(value) {
}
/**
* Get or set the original index of worksheet in the html.
*/
getOriginalSheetIndex() {
}
/**
* Get or set the original index of worksheet in the html.
*/
setOriginalSheetIndex(value) {
}
/**
* Get or set the target index of worksheet where the table is to be located.
*/
getTargetSheetIndex() {
}
/**
* Get or set the target index of worksheet where the table is to be located.
*/
setTargetSheetIndex(value) {
}
/**
* Indicates whether generate list objects from imported table.
* The default value is false.
*/
getTableToListObject() {
}
/**
* Indicates whether generate list objects from imported table.
* The default value is false.
*/
setTableToListObject(value) {
}
}
/**
* Represents the table options when importing html.
*/
class HtmlTableLoadOptionCollection {
/**
*/
constructor() {
}
/**
* Indicates whether generate list objects from imported tables.
* The default value is false.
*/
getTableToListObject() {
}
/**
* Indicates whether generate list objects from imported tables.
* The default value is false.
*/
setTableToListObject(value) {
}
/**
*/
getCount() {
}
/**
* Gets the HtmlTableLoadOption element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {HtmlTableLoadOption} The element at the specified index.
*/
get(index) {
}
/**
* Adds one HtmlTableLoadOption into this collection.
* @param {HtmlTableLoadOption} item - one HtmlTableLoadOption
* @return {Number} the index of the added item
*/
add(item) {
}
/**
* Add a HtmlTableLoadOption to the list.
* @param {Number} tableIndex - Table index
* @return {Number}
*/
add(tableIndex) {
}
/**
* Add a HtmlTableLoadOption to the list.
* @param {String} tableId - Table ID
* @return {Number}
*/
add(tableId) {
}
/**
* Add a HtmlTableLoadOption to the list.
* @param {Number} tableIndex - Table index
* @param {Number} targetSheetIndex - The target index of worksheet in Excel
*/
add(tableIndex, targetSheetIndex) {
}
/**
* Add a HtmlTableLoadOption to the list.
* @param {String} tableId - Table ID
* @param {Number} targetSheetIndex - The target index of worksheet in Excel
* @return {Number}
*/
add(tableId, targetSheetIndex) {
}
/**
* Add a HtmlTableLoadOption to the list.
* @param {Number} tableIndex - Table index
* @param {Number} targetSheetIndex - The target index of worksheet in Excel
* @param {Number} originalSheetIndex - The original index of worksheet in the html
*/
add(tableIndex, targetSheetIndex, originalSheetIndex) {
}
/**
* Add a HtmlTableLoadOption to the list.
* @param {String} tableId - Table ID
* @param {Number} targetSheetIndex - The target index of worksheet in Excel
* @param {Number} originalSheetIndex - The original index of worksheet in the html
* @return {Number}
*/
add(tableId, targetSheetIndex, originalSheetIndex) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Encapsulates the object that represents a hyperlink.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(0);
* //Adding a hyperlink to a URL at "A1" cell
* worksheet.getHyperlinks().add("A1", 1, 1, "http://www.aspose.com");
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Hyperlink {
/**
* Represents the address of a hyperlink.
*/
getAddress() {
}
/**
* Represents the address of a hyperlink.
*/
setAddress(value) {
}
/**
* Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
*/
getTextToDisplay() {
}
/**
* Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
*/
setTextToDisplay(value) {
}
/**
* Gets the range of hyperlink.
*/
getArea() {
}
/**
* Returns or sets the ScreenTip text for the specified hyperlink.
*/
getScreenTip() {
}
/**
* Returns or sets the ScreenTip text for the specified hyperlink.
*/
setScreenTip(value) {
}
/**
* Gets the link type.
* The value of the property is TargetModeType integer constant.
*/
getLinkType() {
}
/**
* Deletes this hyperlink
*/
delete() {
}
}
/**
* Encapsulates a collection of Hyperlink objects.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(0);
* //Get Hyperlinks Collection
* var hyperlinks = worksheet.getHyperlinks();
* //Adding a hyperlink to a URL at "A1" cell
* hyperlinks.add("A1", 1, 1, "http://www.aspose.com");
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class HyperlinkCollection {
/**
*/
getCount() {
}
/**
* Gets the Hyperlink element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Hyperlink} The element at the specified index.
*/
get(index) {
}
/**
* Adds a hyperlink to a specified cell or a range of cells.
* @param {Number} firstRow - First row of the hyperlink range.
* @param {Number} firstColumn - First column of the hyperlink range.
* @param {Number} totalRows - Number of rows in this hyperlink range.
* @param {Number} totalColumns - Number of columns of this hyperlink range.
* @param {String} address - Address of the hyperlink.
* @return {Number} Hyperlink object index.
* @example
* var excel = new aspose.cells.Workbook();
* var worksheet = excel.getWorksheets().get(0);
* worksheet.getHyperlinks().add("A4", 1, 1, "http://www.aspose.com");
* worksheet.getHyperlinks().add("A5", 1, 1, "c:\\book1.xls");
*/
add(firstRow, firstColumn, totalRows, totalColumns, address) {
}
/**
* Adds a hyperlink to a specified cell or a range of cells.
* @param {String} cellName - Cell name.
* @param {Number} totalRows - Number of rows in this hyperlink range.
* @param {Number} totalColumns - Number of columns of this hyperlink range.
* @param {String} address - Address of the hyperlink.
* @return {Number} Hyperlink object index.
*/
add(cellName, totalRows, totalColumns, address) {
}
/**
* Adds a hyperlink to a specified cell or a range of cells.
* @param {String} startCellName - The top-left cell of the range.
* @param {String} endCellName - The bottom-right cell of the range.
* @param {String} address - Address of the hyperlink.
* @param {String} textToDisplay - The text to be displayed for the specified hyperlink.
* @param {String} screenTip - The screenTip text for the specified hyperlink.
* @return {Number} Hyperlink object index.
*/
add(startCellName, endCellName, address, textToDisplay, screenTip) {
}
/**
* Remove the hyperlink at the specified index in this collection.
* @param {Number} index - The zero based index of the element.
*/
removeAt(index) {
}
/**
* Clears all hyperlinks.
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents icon filter.
* @hideconstructor
*/
class IconFilter {
/**
* Gets and sets which icon set is used in the filter criteria.
* The value of the property is IconSetType integer constant.
*/
getIconSetType() {
}
/**
* Gets and sets which icon set is used in the filter criteria.
* The value of the property is IconSetType integer constant.
*/
setIconSetType(value) {
}
/**
* Gets and sets Zero-based index of an icon in an icon set.
*/
getIconId() {
}
/**
* Gets and sets Zero-based index of an icon in an icon set.
*/
setIconId(value) {
}
}
/**
* Describe the IconSet conditional formatting rule.
* This conditional formatting rule applies icons to cells
* according to their values.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* //Adds an empty conditional formatting
* var index = sheet.getConditionalFormattings().add();
* var fcs = sheet.getConditionalFormattings().get(index);
* //Sets the conditional format range.
* var ca = new aspose.cells.CellArea();
* ca.StartRow = 0;
* ca.EndRow = 2;
* ca.StartColumn = 0;
* ca.EndColumn = 0;
* fcs.addArea(ca);
* //Adds condition.
* var idx = fcs.addCondition(aspose.cells.FormatConditionType.ICON_SET);
* fcs.addArea(ca);
* var cond = fcs.get(idx);
* //Get Icon Set
* var iconSet = cond.getIconSet();
* //Set Icon Type
* iconSet.setType(aspose.cells.IconSetType.ARROWS_3);
* //Put Cell Values
* var cell1 = sheet.getCells().get("A1");
* cell1.putValue(10);
* var cell2 = sheet.getCells().get("A2");
* cell2.putValue(120);
* var cell3 = sheet.getCells().get("A3");
* cell3.putValue(260);
* //Saving the Excel file
* workbook.save("D:\\book1.xlsx");
* @hideconstructor
*/
class IconSet {
/**
* Get theConditionalFormattingIcon from the collection
*/
getCfIcons() {
}
/**
* Get the CFValueObjects instance.
*/
getCfvos() {
}
/**
* 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.
* The value of the property is IconSetType integer constant.
*/
getType() {
}
/**
* 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.
* The value of the property is IconSetType integer constant.
*/
setType(value) {
}
/**
* Indicates whether the icon set is custom.
* Default value is false.
*/
isCustom() {
}
/**
* 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() {
}
/**
* 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.
*/
setShowValue(value) {
}
/**
* Get or set the flag indicating whether to reverses the default order of the icons in this icon set.
* Default value is false.
*/
getReverse() {
}
/**
* Get or set the flag indicating whether to reverses the default order of the icons in this icon set.
* Default value is false.
*/
setReverse(value) {
}
}
/**
* Represents the image control.
* @hideconstructor
*/
class ImageActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBorderOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBorderOleColor(value) {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
getBorderStyle() {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
setBorderStyle(value) {
}
/**
* Gets and sets how to display the picture.
* The value of the property is ControlPictureSizeMode integer constant.
*/
getPictureSizeMode() {
}
/**
* Gets and sets how to display the picture.
* The value of the property is ControlPictureSizeMode integer constant.
*/
setPictureSizeMode(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Gets and sets the data of the picture.
*/
getPicture() {
}
/**
* Gets and sets the data of the picture.
*/
setPicture(value) {
}
/**
* Gets and sets the alignment of the picture inside the Form or Image.
* The value of the property is ControlPictureAlignmentType integer constant.
*/
getPictureAlignment() {
}
/**
* Gets and sets the alignment of the picture inside the Form or Image.
* The value of the property is ControlPictureAlignmentType integer constant.
*/
setPictureAlignment(value) {
}
/**
* Indicates whether the picture is tiled across the background.
*/
isTiled() {
}
/**
* Indicates whether the picture is tiled across the background.
*/
setTiled(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Specifies the file format of the image.
* @hideconstructor
*/
class ImageFormat {
/**
* Gets the bitmap (BMP) image format.
* @return {ImageFormat} An ImageFormat object that indicates the bitmap image format.
*/
static getBmp() {
}
/**
* Gets the enhanced metafile (EMF) image format.
* @return {ImageFormat} An ImageFormat object that indicates the enhanced metafile image format.
*/
static getEmf() {
}
/**
* Gets the Exchangeable Image File (Exif) format.
* @return {ImageFormat} An ImageFormat object that indicates the Exif format.
*/
static getExif() {
}
/**
* Gets the Graphics Interchange Format (GIF) image format.
* @return {ImageFormat} An ImageFormat object that indicates the GIF image format.
*/
static getGif() {
}
/**
* Gets the Windows icon image format.
* @return {ImageFormat} An ImageFormat object that indicates the Windows icon image format.
*/
static getIcon() {
}
/**
* Gets the Joint Photographic Experts Group (JPEG) image format.
* @return {ImageFormat} An ImageFormat object that indicates the JPEG image format.
*/
static getJpeg() {
}
/**
* Gets a memory bitmap image format.
* @return {ImageFormat} An ImageFormat object that indicates the memory bitmap image format.
*/
static getMemoryBmp() {
}
/**
* Gets the W3C Portable Network Graphics (PNG) image format.
* @return {ImageFormat} An ImageFormat object that indicates the PNG image format.
*/
static getPng() {
}
/**
* Gets the Tagged Image File Format (TIFF) image format.
* @return {ImageFormat} An ImageFormat object that indicates the TIFF image format.
*/
static getTiff() {
}
/**
* Gets the Windows metafile (WMF) image format.
* @return {ImageFormat} An ImageFormat object that indicates the Windows metafile image format.
*/
static getWmf() {
}
/**
* Returns a value that indicates whether the specified object is an ImageFormat
* object that is equivalent to this ImageFormat object.
* @param {Object} obj - The object to test.
* @return {boolean} true if o is an ImageFormat object that is equivalent to this ImageFormat object; otherwise, false.
*/
equals(obj) {
}
/**
* Get the string name of this ImageFormat instance
* @return {String} The string name of this ImageFormat instance
*/
getName() {
}
/**
* Get the image format according to suffix name
* @param {String} name - suffix name
* @return {ImageFormat} >An ImageFormat object according to the suffix name.
*/
static getImageFormatFromSuffixName(name) {
}
}
/**
* Allows to specify options when rendering worksheet to images, printing worksheet or rendering chart to image.
* @example
* //Set Image Or Print Options
* var options = new aspose.cells.ImageOrPrintOptions();
* //set Horizontal resolution
* options.setHorizontalResolution(200);
* //set Vertica; Resolution
* options.setVerticalResolution(300);
* //Instantiate Workbook
* var book = new aspose.cells.Workbook("Book1.xls");
* //Save chart as Image using ImageOrPrint Options
* book.getWorksheets().get(0).getCharts().get(0).toImage("chart.png", options);
*/
class ImageOrPrintOptions {
/**
*/
constructor() {
}
/**
* Gets or sets the output file format type
* Support Tiff/XPS
* The value of the property is SaveFormat integer constant.
* NOTE: This member is now obsolete. Instead,
* For Tiff/Svg, use ImageType; For Xps, use Workbook.save(java.lang.String, com.aspose.cells.SaveOptions) with XpsSaveOptions.
* This property will be removed 12 months later since August 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSaveFormat() {
}
/**
* Gets or sets the output file format type
* Support Tiff/XPS
* The value of the property is SaveFormat integer constant.
* NOTE: This member is now obsolete. Instead,
* For Tiff/Svg, use ImageType; For Xps, use Workbook.save(java.lang.String, com.aspose.cells.SaveOptions) with XpsSaveOptions.
* This property will be removed 12 months later since August 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSaveFormat(value) {
}
/**
* If PrintWithStatusDialog = true , there will be a dialog that shows current print status.
* else no such dialog will show.
*/
getPrintWithStatusDialog() {
}
/**
* If PrintWithStatusDialog = true , there will be a dialog that shows current print status.
* else no such dialog will show.
*/
setPrintWithStatusDialog(value) {
}
/**
* Gets or sets the horizontal resolution for generated images, in dots per inch.
* Applies generating image method except Emf format images.
* The default value is 96.
*/
getHorizontalResolution() {
}
/**
* Gets or sets the horizontal resolution for generated images, in dots per inch.
* Applies generating image method except Emf format images.
* The default value is 96.
*/
setHorizontalResolution(value) {
}
/**
* Gets or sets the vertical resolution for generated images, in dots per inch.
* Applies generating image method except Emf format image.
* The default value is 96.
*/
getVerticalResolution() {
}
/**
* Gets or sets the vertical resolution for generated images, in dots per inch.
* Applies generating image method except Emf format image.
* The default value is 96.
*/
setVerticalResolution(value) {
}
/**
* Gets or sets the type of compression to apply only when saving pages to the Tiff format.
* The value of the property is TiffCompression integer constant.
* Has effect only when saving to TIFF.
* The default value is Lzw.
*/
getTiffCompression() {
}
/**
* Gets or sets the type of compression to apply only when saving pages to the Tiff format.
* The value of the property is TiffCompression integer constant.
* Has effect only when saving to TIFF.
* The default value is Lzw.
*/
setTiffCompression(value) {
}
/**
* Gets or sets bit depth to apply only when saving pages to the Tiff format.
* The value of the property is ColorDepth integer constant.
* 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() {
}
/**
* Gets or sets bit depth to apply only when saving pages to the Tiff format.
* The value of the property is ColorDepth integer constant.
* 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) {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
*/
getPrintingPage() {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
*/
setPrintingPage(value) {
}
/**
* 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
* Has effect only when saving to JPEG.
* The value must be between 0 and 100.
* The default value is 100.
*/
getQuality() {
}
/**
* 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
* Has effect only when saving to JPEG.
* The value must be between 0 and 100.
* The default value is 100.
*/
setQuality(value) {
}
/**
* Gets or sets the format of the generated images.
* default value: PNG.
* The value of the property is ImageType integer constant.
*/
getImageType() {
}
/**
* Gets or sets the format of the generated images.
* default value: PNG.
* The value of the property is ImageType integer constant.
*/
setImageType(value) {
}
/**
* Indicates whether the width and height of the cells is automatically fitted by cell value.
* The default value is false.
* NOTE: This member is now obsolete. Instead,
* please use Worksheet.autoFitColumns(com.aspose.cells.AutoFitterOptions) and Worksheet.autoFitRows(com.aspose.cells.AutoFitterOptions).
* This property will be removed 12 months later since August 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isCellAutoFit() {
}
/**
* Indicates whether the width and height of the cells is automatically fitted by cell value.
* The default value is false.
* NOTE: This member is now obsolete. Instead,
* please use Worksheet.autoFitColumns(com.aspose.cells.AutoFitterOptions) and Worksheet.autoFitRows(com.aspose.cells.AutoFitterOptions).
* This property will be removed 12 months later since August 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCellAutoFit(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOnePagePerSheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAllColumnsInOnePagePerSheet(value) {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
getDrawObjectEventHandler() {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
setDrawObjectEventHandler(value) {
}
/**
* Indicate the chart imagetype when converting.
* default value: PNG.
* NOTE: This member is now obsolete. Instead,
* Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getChartImageType() {
}
/**
* Indicate the chart imagetype when converting.
* default value: PNG.
* NOTE: This member is now obsolete. Instead,
* Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setChartImageType(value) {
}
/**
* Indicate the filename of embedded image in svg.
* This should be full path with directory like "c:\\xpsEmbedded"
*/
getEmbededImageNameInSvg() {
}
/**
* Indicate the filename of embedded image in svg.
* This should be full path with directory like "c:\\xpsEmbedded"
*/
setEmbededImageNameInSvg(value) {
}
/**
* if this property is true, the generated svg will fit to view port.
*/
getSVGFitToViewPort() {
}
/**
* if this property is true, the generated svg will fit to view port.
*/
setSVGFitToViewPort(value) {
}
/**
* If this property is true , one Area will be output, and no scale will take effect.
*/
getOnlyArea() {
}
/**
* If this property is true , one Area will be output, and no scale will take effect.
*/
setOnlyArea(value) {
}
/**
* Indicates if the background of generated image should be transparent.
* The default value is false. That means the background of the generated images is white.
*/
getTransparent() {
}
/**
* Indicates if the background of generated image should be transparent.
* The default value is false. That means the background of the generated images is white.
*/
setTransparent(value) {
}
/**
* Control/Indicate progress of page saving process.
*/
getPageSavingCallback() {
}
/**
* Control/Indicate progress of page saving process.
*/
setPageSavingCallback(value) {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
isFontSubstitutionCharGranularity() {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
setFontSubstitutionCharGranularity(value) {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
getPageIndex() {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
setPageIndex(value) {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered.
*/
getPageCount() {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered.
*/
setPageCount(value) {
}
/**
* Indicates whether to optimize the output elements.
* 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() {
}
/**
* Indicates whether to optimize the output elements.
* 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.
*/
setOptimized(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDefaultFont(value) {
}
/**
* 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.
* Default is true.
*/
getCheckWorkbookDefaultFont() {
}
/**
* 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.
* Default is true.
*/
setCheckWorkbookDefaultFont(value) {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is false.
*/
getOutputBlankPageWhenNothingToPrint() {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is false.
*/
setOutputBlankPageWhenNothingToPrint(value) {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
getGridlineType() {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
setGridlineType(value) {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
getTextCrossType() {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
setTextCrossType(value) {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
getDefaultEditLanguage() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
setDefaultEditLanguage(value) {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
* The set is ignored when it is used in SheetRender
*/
getSheetSet() {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
* The set is ignored when it is used in SheetRender
*/
setSheetSet(value) {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to image, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
* For the frameworks that depend on .Net System.Drawing.Common, this setting is ignored.
*/
getEmfRenderSetting() {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to image, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
* For the frameworks that depend on .Net System.Drawing.Common, this setting is ignored.
*/
setEmfRenderSetting(value) {
}
/**
* Gets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format.
* Has effect only when saving to TIFF.
* The default value is -1, represent no PhotometricInterpretation is applied.
*/
getTiffPhotometricInterpretation() {
}
/**
* Sets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format.
* Has effect only when saving to TIFF.
* The default value is -1, represent no PhotometricInterpretation is applied.
*/
setTiffPhotometricInterpretation(value) {
}
/**
* Sets the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values.
* @param {Key} key - the key of the hint to be set.
* @param {Object} value - the value indicating preferences for the specified hint category.
*/
setRenderingHint(key, value) {
}
/**
* Sets desired width and height of image.
* NOTE: This member is now obsolete. Instead,
* please use setDesiredSize(int, int, boolean) by setting param keepAspectRatio to false.
* This property will be removed 12 months later since May 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} desiredWidth - desired width in pixels
* @param {Number} desiredHeight - desired height in pixels
*/
setDesiredSize(desiredWidth, desiredHeight) {
}
/**
* Sets desired width and height of image.
* @param {Number} desiredWidth - desired width in pixels
* @param {Number} desiredHeight - desired height in pixels
* @param {boolean} keepAspectRatio - whether to keep aspect ratio of origin image
*/
setDesiredSize(desiredWidth, desiredHeight, keepAspectRatio) {
}
}
/**
* Represents image save options.
* For advanced usage, please use WorkbookRender or SheetRender.
*/
class ImageSaveOptions {
/**
* Creates the options for saving image file.
* The default type is Tiff.
*/
constructor() {
}
/**
* Creates the options for saving image file.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Additional image creation options.
* For advanced usage, please use WorkbookRender or SheetRender.
*/
getImageOrPrintOptions() {
}
/**
* Gets or sets the IStreamProvider for exporting objects.
* If saving as Tiff, this property is ignored.
* Otherwise, if more than one image should be saving, we will write other images by this.
* For advanced usage, please use WorkbookRender or SheetRender.
*/
getStreamProvider() {
}
/**
* Gets or sets the IStreamProvider for exporting objects.
* If saving as Tiff, this property is ignored.
* Otherwise, if more than one image should be saving, we will write other images by this.
* For advanced usage, please use WorkbookRender or SheetRender.
*/
setStreamProvider(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Font configs for each Workbook object.
*/
class IndividualFontConfigs {
/**
* Ctor.
*/
constructor() {
}
/**
* Font substitute names for given original font name.
* @param {String} originalFontName - Original font name.
* @param {String[]} substituteFontNames - List of font substitute names to be used if original font is not presented.
*/
setFontSubstitutes(originalFontName, substituteFontNames) {
}
/**
* Returns array containing font substitute names to be used if original font is not presented.
* @param {String} originalFontName - originalFontName
* @return {String[]} An array containing font substitute names to be used if original font is not presented.
*/
getFontSubstitutes(originalFontName) {
}
/**
* Sets the fonts folder
* @param {String} fontFolder - The folder that contains TrueType fonts.
* @param {boolean} recursive - Determines whether or not to scan subfolders.
*/
setFontFolder(fontFolder, recursive) {
}
/**
* Sets the fonts folders
* @param {String[]} fontFolders - The folders that contains TrueType fonts.
* @param {boolean} recursive - Determines whether or not to scan subfolders.
*/
setFontFolders(fontFolders, recursive) {
}
/**
* Sets the fonts sources.
* @param {FontSourceBase[]} sources - An array of sources that contain TrueType fonts.
*/
setFontSources(sources) {
}
/**
* Sets the fonts exclusive sources. Only fonts in the sources will be used.
* System.setProperty("Aspose.Cells.FontDirExc", "fontExclusiveFolder") will be ignored if this is set.
* @param {FontSourceBase[]} exclusiveSources - An array of sources that contain TrueType fonts.
*/
setFontExclusiveSources(exclusiveSources) {
}
/**
* Gets a copy of the array that contains the list of sources
* @return {FontSourceBase[]}
*/
getFontSources() {
}
}
/**
* Represents the options of inserting.
*/
class InsertOptions {
/**
*/
constructor() {
}
/**
* The value of the property is CopyFormatType integer constant.
*/
getCopyFormatType() {
}
/**
* The value of the property is CopyFormatType integer constant.
*/
setCopyFormatType(value) {
}
/**
* Indicates if references in other worksheets will be updated.
*/
getUpdateReference() {
}
/**
* Indicates if references in other worksheets will be updated.
*/
setUpdateReference(value) {
}
}
/**
* Represents the options of json layout type.
*/
class JsonLayoutOptions {
/**
*/
constructor() {
}
/**
* Processes Array as table.
*/
getArrayAsTable() {
}
/**
* Processes Array as table.
*/
setArrayAsTable(value) {
}
/**
* Indicates whether ignoring null value.
*/
getIgnoreNull() {
}
/**
* Indicates whether ignoring null value.
*/
setIgnoreNull(value) {
}
/**
* Indicates whether ignore title if array is a property of object.
* NOTE: This property is now obsolete.
* Instead, please use JsonLayoutOptions.IgnoreTitle property instead.
* This property will be removed 6 months later since February 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getIgnoreArrayTitle() {
}
/**
* Indicates whether ignore title if array is a property of object.
* NOTE: This property is now obsolete.
* Instead, please use JsonLayoutOptions.IgnoreTitle property instead.
* This property will be removed 6 months later since February 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setIgnoreArrayTitle(value) {
}
/**
* Indicates whether ignore title if object is a property of object.
* NOTE: This property is now obsolete.
* Instead, please use JsonLayoutOptions.IgnoreTitle property instead.
* This property will be removed 6 months later since February 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getIgnoreObjectTitle() {
}
/**
* Indicates whether ignore title if object is a property of object.
* NOTE: This property is now obsolete.
* Instead, please use JsonLayoutOptions.IgnoreTitle property instead.
* This property will be removed 6 months later since February 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setIgnoreObjectTitle(value) {
}
/**
* Ingores titles of attributes
*/
getIgnoreTitle() {
}
/**
* Ingores titles of attributes
*/
setIgnoreTitle(value) {
}
/**
* Indicates whether converting the string in json to numeric or date value.
*/
getConvertNumericOrDate() {
}
/**
* Indicates whether converting the string in json to numeric or date value.
*/
setConvertNumericOrDate(value) {
}
/**
* Gets and sets the format of numeric value.
*/
getNumberFormat() {
}
/**
* Gets and sets the format of numeric value.
*/
setNumberFormat(value) {
}
/**
* Gets and sets the format of date value.
*/
getDateFormat() {
}
/**
* Gets and sets the format of date value.
*/
setDateFormat(value) {
}
/**
* Gets and sets the style of the title.
*/
getTitleStyle() {
}
/**
* Gets and sets the style of the title.
*/
setTitleStyle(value) {
}
}
/**
* Represents the options of loading json files
*/
class JsonLoadOptions {
/**
* Creates an options of loading the file.
*/
constructor() {
}
/**
* Gets and sets the start cell.
*/
getStartCell() {
}
/**
* Gets and sets the start cell.
*/
setStartCell(value) {
}
/**
* The options of import json.
*/
getLayoutOptions() {
}
/**
* The options of import json.
*/
setLayoutOptions(value) {
}
/**
* Indicates whether importing each attribute of JsonObject object as one worksheet when all child nodes are array nodes.
*/
getMultipleWorksheets() {
}
/**
* Indicates whether importing each attribute of JsonObject object as one worksheet when all child nodes are array nodes.
*/
setMultipleWorksheets(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents the options of saving the workbook as a json file.
*/
class JsonSaveOptions {
/**
* Creates options for saving json file.
*/
constructor() {
}
/**
* Represents the type of exporting hyperlink to json.
* The value of the property is JsonExportHyperlinkType integer constant.
* The default value is JsonExportHyperlinkType.DISPLAY_STRING;
*/
getExportHyperlinkType() {
}
/**
* Represents the type of exporting hyperlink to json.
* The value of the property is JsonExportHyperlinkType integer constant.
* The default value is JsonExportHyperlinkType.DISPLAY_STRING;
*/
setExportHyperlinkType(value) {
}
/**
* Indicates whether skipping emtpy rows.
*/
getSkipEmptyRows() {
}
/**
* Indicates whether skipping emtpy rows.
*/
setSkipEmptyRows(value) {
}
/**
* Represents the indexes of exported sheets.
*/
getSheetIndexes() {
}
/**
* Represents the indexes of exported sheets.
*/
setSheetIndexes(value) {
}
/**
* Gets or sets the exporting range.
*/
getExportArea() {
}
/**
* Gets or sets the exporting range.
*/
setExportArea(value) {
}
/**
* Indicates whether the range contains header row.
*/
hasHeaderRow() {
}
/**
* Indicates whether the range contains header row.
*/
setHasHeaderRow(value) {
}
/**
* Exports the string value of the cells to json.
*/
getExportAsString() {
}
/**
* Exports the string value of the cells to json.
*/
setExportAsString(value) {
}
/**
* Indicates the indent.
* If the indent is null or empty, the exported json is not formatted.
*/
getIndent() {
}
/**
* Indicates the indent.
* If the indent is null or empty, the exported json is not formatted.
*/
setIndent(value) {
}
/**
* Exported as parent-child hierarchy Json structure.
*/
getExportNestedStructure() {
}
/**
* Exported as parent-child hierarchy Json structure.
*/
setExportNestedStructure(value) {
}
/**
* Indicates whether exporting empty cells as null.
*/
getExportEmptyCells() {
}
/**
* Indicates whether exporting empty cells as null.
*/
setExportEmptyCells(value) {
}
/**
* Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
*/
getAlwaysExportAsJsonObject() {
}
/**
* Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
*/
setAlwaysExportAsJsonObject(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents the utility class of processing json.
*/
class JsonUtility {
/**
*/
constructor() {
}
/**
* Import the json string.
* @param {String} json - The json string.
* @param {Cells} cells - The Cells.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @param {JsonLayoutOptions} option - The options of import json string.
* @return {Number[]}
*/
static importData(json, cells, row, column, option) {
}
/**
* Exporting the range to json file.
* NOTE: This member is now obsolete. Instead,
* please use ExportRangeToJson(Range range, JsonSaveOptions options) method.
* This property will be removed 6 months later since November 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Range} range - The range.
* @param {ExportRangeToJsonOptions} options - The options of exporting.
* @return {String} The json string value.
*/
static exportRangeToJson(range, options) {
}
/**
* Exporting the range to json file.
* @param {Range} range - The range.
* @param {JsonSaveOptions} options - The options of exporting.
* @return {String} The json string value.
*/
static exportRangeToJson(range, options) {
}
}
/**
* Encapsulates the object that represents a label in a spreadsheet.
* @example
* //Create a new Workbook.
* var workbook = new aspose.cells.Workbook();
* //Get the first worksheet in the workbook.
* var sheet = workbook.getWorksheets().get(0);
* //Add a new label to the worksheet.
* var label = sheet.getShapes().addShape(aspose.cells.MsoDrawingType.LABEL, 2, 0, 2, 0, 60, 120);
* //Set the caption of the label.
* label.setText("This is a Label");
* //Set the Placement Type, the way the
* //label is attached to the cells.
* label.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Set the fill color of the label.
* label.getFillFormat().setForeColor(aspose.cells.Color.getYellow());
* //Saves the file.
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Label {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents the label ActiveX control.
* @hideconstructor
*/
class LabelActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
getCaption() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
setCaption(value) {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
getPicturePosition() {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
setPicturePosition(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBorderOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBorderOleColor(value) {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
getBorderStyle() {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
setBorderStyle(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Gets and sets the data of the picture.
*/
getPicture() {
}
/**
* Gets and sets the data of the picture.
*/
setPicture(value) {
}
/**
* Gets and sets the accelerator key for the control.
*/
getAccelerator() {
}
/**
* Gets and sets the accelerator key for the control.
*/
setAccelerator(value) {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
isWordWrapped() {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
setWordWrapped(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Encapsulates the object that represents the chart legend.
* @example
* //Set Legend's width and height
* var workbook = new aspose.cells.Workbook();
* var sheetIndex = workbook.getWorksheets().add();
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* var charts = worksheet.getCharts();
* //Create a chart
* var chart = charts.get(charts.add(aspose.cells.ChartType.COLUMN, 1, 1, 10, 10));
* var legend = chart.getLegend();
* //Legend is at right side of chart by default.
* //If the legend is at left or right side of the chart, setting Legend.X property will not take effect.
* //If the legend is at top or bottom side of the chart, setting Legend.Y property will not take effect.
* legend.setY(1500);
* legend.setWidth(50);
* legend.setHeight(50);
* //Set legend's position
* legend.setPosition(aspose.cells.LegendPositionType.LEFT);
* @hideconstructor
*/
class Legend {
/**
* Gets or sets the legend position type.
* The value of the property is LegendPositionType integer constant.Default position is right.If the legend is at left or right side of the chart, setting Legend.X property will not take effect.If the legend is at top or bottom side of the chart, setting Legend.Y property will not take effect.
*/
getPosition() {
}
/**
* Gets or sets the legend position type.
* The value of the property is LegendPositionType integer constant.Default position is right.If the legend is at left or right side of the chart, setting Legend.X property will not take effect.If the legend is at top or bottom side of the chart, setting Legend.Y property will not take effect.
*/
setPosition(value) {
}
/**
* Gets a collection of all the LegendEntry objects in the specified chart legend.
* Setting the legend entries of the surface chart is not supported.
* So it will return null if the chart type is surface chart type.
*/
getLegendEntries() {
}
/**
* Gets the labels of the legend entries after call Chart.Calculate() method.
* NOTE: This member is now obsolete. Instead,
* please use Legend.GetLegendLabels method.
* This property will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLegendEntriesLabels() {
}
/**
* Gets or sets whether other chart elements shall be allowed to overlap this chart element.
*/
isOverLay() {
}
/**
* Gets or sets whether other chart elements shall be allowed to overlap this chart element.
*/
setOverLay(value) {
}
/**
* Indicates the text is auto generated.
*/
isAutoText() {
}
/**
* Indicates the text is auto generated.
*/
setAutoText(value) {
}
/**
* Indicates whether this data labels is deleted.
*/
isDeleted() {
}
/**
* Indicates whether this data labels is deleted.
*/
setDeleted(value) {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
getRotationAngle() {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
setRotationAngle(value) {
}
/**
* Indicates whether the text of the chart is automatically rotated.
*/
isAutomaticRotation() {
}
/**
* Gets or sets the text of a frame's title.
*/
getText() {
}
/**
* Gets or sets the text of a frame's title.
*/
setText(value) {
}
/**
* Gets and sets a reference to the worksheet.
*/
getLinkedSource() {
}
/**
* Gets and sets a reference to the worksheet.
*/
setLinkedSource(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextDirection() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTextDirection(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
getReadingOrder() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
setReadingOrder(value) {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
getDirectionType() {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
setDirectionType(value) {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
isTextWrapped() {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
setTextWrapped(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setResizeShapeToFitText(value) {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the area.
*/
getArea() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* Gets a Font object of the specified ChartFrame object.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
getX() {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* X In Pixels = X * Chart.ChartObject.Width / 4000;
*/
setX(value) {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getY() {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Y In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setY(value) {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getHeight() {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setHeight(value) {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
getWidth() {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
setWidth(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Gets the labels of the legend entries after call Chart.Calculate() method.
*/
getLegendLabels() {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Set position of the frame to automatic
*/
setPositionAuto() {
}
}
/**
* Represents a legend entry in a chart legend.
* @hideconstructor
*/
class LegendEntry {
/**
* Gets and sets whether the legend entry is deleted.
*/
isDeleted() {
}
/**
* Gets and sets whether the legend entry is deleted.
*/
setDeleted(value) {
}
/**
* Gets a Font object of the specified ChartFrame object.
*/
getFont() {
}
/**
* Gets a Font object of the specified LegendEntry object.
* NOTE: This member is now obsolete. Instead,
* please use LegendEntry.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets or sets no fill of the text.
*/
isTextNoFill() {
}
/**
* Gets or sets no fill of the text.
*/
setTextNoFill(value) {
}
/**
* True if the text in the object changes font size when the object size changes.
* The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes.
* The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use LegendEntry.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use LegendEntry.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
}
/**
* Represents a collection of all the LegendEntry objects in the specified chart legend.
* @hideconstructor
*/
class LegendEntryCollection {
/**
*/
getCount() {
}
/**
* Gets the LegendEntry element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {LegendEntry} The element at the specified index.
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Provides methods to license the component.
* @exampleIn this example, an attempt will be made to find a license file named MyLicense.lic in the folder that contains the component, in the folder that contains the calling assembly,in the folder of the entry assembly and then in the embedded resources of the calling assembly.
* var license = new aspose.cells.License();
* license.setLicense("MyLicense.lic");
*/
class License {
/**
* Initializes a new instance of this class.
*/
constructor() {
}
/**
* Licenses the component.
* Tries to find the license in the following locations:1. Explicit path.2. The current working directory of the java application.3. The folder that contains the Aspose component JAR file.4. The folder that contains the client's calling JAR file.
*/
setLicense(licenseName) {
}
/**
* Licenses the component.
* Use this method to load a license from a stream.
* @param {License} license - The license object
* @param {ReadableStream} stream - The stream
* @param {Callback} callback - The callback function
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var licenseStream = fs.createReadStream("Aspose.Cells.lic");
* var license = new aspose.cells.License();
* aspose.cells.License.setLicenseFromStream(license, licenseStream,
* function(err) {
* if (err) {
* console.log("license error");
* return;
* }
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var writeStream = fs.createWriteStream("result-stream.xlsx");
* aspose.cells.Workbook.saveToStream(workbook, writeStream, aspose.cells.SaveFormat.XLSX);
* });
*/
static setLicenseFromStream(license, stream, callback) {
}
}
/**
* Encapsulates the object that represents the line format.
* @example
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* cells.get("a1").putValue(2);
* cells.get("a2").putValue(5);
* cells.get("a3").putValue(3);
* cells.get("a4").putValue(6);
* cells.get("b1").putValue(4);
* cells.get("b2").putValue(3);
* cells.get("b3").putValue(6);
* cells.get("b4").putValue(7);
* var chartIndex = workbook.getWorksheets().get(0).getCharts().add(aspose.cells.ChartType.COLUMN, 11, 0, 27, 10);
* var chart = workbook.getWorksheets().get(0).getCharts().get(chartIndex);
* chart.getNSeries().add("A1:B4", true);
* //Applying a dotted line style on the lines of an NSeries
* chart.getNSeries().get(0).getBorder().setStyle(aspose.cells.LineType.DOT);
* //Applying a triangular marker style on the data markers of an NSeries
* chart.getNSeries().get(0).getMarker().setMarkerStyle(aspose.cells.ChartMarkerType.TRIANGLE);
* //Setting the weight of all lines in an NSeries to medium
* chart.getNSeries().get(0).getBorder().setWeight(aspose.cells.WeightType.MEDIUM_LINE);
* @hideconstructor
*/
class Line {
/**
* Specifies the compound line type
* The value of the property is MsoLineStyle integer constant.
*/
getCompoundType() {
}
/**
* Specifies the compound line type
* The value of the property is MsoLineStyle integer constant.
*/
setCompoundType(value) {
}
/**
* Specifies the dash line type
* The value of the property is MsoLineDashStyle integer constant.
*/
getDashType() {
}
/**
* Specifies the dash line type
* The value of the property is MsoLineDashStyle integer constant.
*/
setDashType(value) {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
getCapType() {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
setCapType(value) {
}
/**
* Specifies the joining caps.
* The value of the property is LineJoinType integer constant.
*/
getJoinType() {
}
/**
* Specifies the joining caps.
* The value of the property is LineJoinType integer constant.
*/
setJoinType(value) {
}
/**
* Specifies an arrowhead for the begin of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getBeginType() {
}
/**
* Specifies an arrowhead for the begin of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setBeginType(value) {
}
/**
* Specifies an arrowhead for the end of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getEndType() {
}
/**
* Specifies an arrowhead for the end of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setEndType(value) {
}
/**
* Specifies the length of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getBeginArrowLength() {
}
/**
* Specifies the length of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setBeginArrowLength(value) {
}
/**
* Specifies the length of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getEndArrowLength() {
}
/**
* Specifies the length of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setEndArrowLength(value) {
}
/**
* Specifies the width of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getBeginArrowWidth() {
}
/**
* Specifies the width of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setBeginArrowWidth(value) {
}
/**
* Specifies the width of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getEndArrowWidth() {
}
/**
* Specifies the width of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setEndArrowWidth(value) {
}
/**
* Gets and sets the theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
getThemeColor() {
}
/**
* Gets and sets the theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
setThemeColor(value) {
}
/**
* Represents the com.aspose.cells.Color of the line.
*/
getColor() {
}
/**
* Represents the com.aspose.cells.Color of the line.
*/
setColor(value) {
}
/**
* Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Represents the style of the line.
* The value of the property is LineType integer constant.
*/
getStyle() {
}
/**
* Represents the style of the line.
* The value of the property is LineType integer constant.
*/
setStyle(value) {
}
/**
* Gets or sets the WeightType of the line.
* The value of the property is WeightType integer constant.
*/
getWeight() {
}
/**
* Gets or sets the WeightType of the line.
* The value of the property is WeightType integer constant.
*/
setWeight(value) {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
getWeightPt() {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
setWeightPt(value) {
}
/**
* Gets or sets the weight of the line in unit of pixels.
*/
getWeightPx() {
}
/**
* Gets or sets the weight of the line in unit of pixels.
*/
setWeightPx(value) {
}
/**
* Gets or sets format type.
* The value of the property is ChartLineFormattingType integer constant.
*/
getFormattingType() {
}
/**
* Gets or sets format type.
* The value of the property is ChartLineFormattingType integer constant.
*/
setFormattingType(value) {
}
/**
* Indicates whether the color of line is automatic assigned.
*/
isAutomaticColor() {
}
/**
* Represents whether the line is visible.
*/
isVisible() {
}
/**
* Represents whether the line is visible.
*/
setVisible(value) {
}
/**
* Indicates whether this line style is auto assigned.
*/
isAuto() {
}
/**
* Indicates whether this line style is auto assigned.
*/
setAuto(value) {
}
/**
* Represents gradient fill.
*/
getGradientFill() {
}
}
/**
* Represents all setting of the line.
* @hideconstructor
*/
class LineFormat {
/**
* Specifies the line compound type.
* The value of the property is MsoLineStyle integer constant.
*/
getCompoundType() {
}
/**
* Specifies the line compound type.
* The value of the property is MsoLineStyle integer constant.
*/
setCompoundType(value) {
}
/**
* Specifies the line dash type.
* The value of the property is MsoLineDashStyle integer constant.
*/
getDashStyle() {
}
/**
* Specifies the line dash type.
* The value of the property is MsoLineDashStyle integer constant.
*/
setDashStyle(value) {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
getCapType() {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
setCapType(value) {
}
/**
* Specifies the line join type.
* The value of the property is LineJoinType integer constant.
*/
getJoinType() {
}
/**
* Specifies the line join type.
* The value of the property is LineJoinType integer constant.
*/
setJoinType(value) {
}
/**
* Gets and sets the begin arrow type of the line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getBeginArrowheadStyle() {
}
/**
* Gets and sets the begin arrow type of the line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setBeginArrowheadStyle(value) {
}
/**
* Gets and sets the begin arrow width type of the line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getBeginArrowheadWidth() {
}
/**
* Gets and sets the begin arrow width type of the line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setBeginArrowheadWidth(value) {
}
/**
* Gets and sets the begin arrow length type of the line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getBeginArrowheadLength() {
}
/**
* Gets and sets the begin arrow length type of the line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setBeginArrowheadLength(value) {
}
/**
* Gets and sets the end arrow type of the line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getEndArrowheadStyle() {
}
/**
* Gets and sets the end arrow type of the line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setEndArrowheadStyle(value) {
}
/**
* Gets and sets the end arrow width type of the line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getEndArrowheadWidth() {
}
/**
* Gets and sets the end arrow width type of the line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setEndArrowheadWidth(value) {
}
/**
* Gets and sets the end arrow length type of the line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getEndArrowheadLength() {
}
/**
* Gets and sets the end arrow length type of the line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setEndArrowheadLength(value) {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
getWeight() {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
setWeight(value) {
}
/**
* Gets and sets the fill type.
* The value of the property is FillType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getType() {
}
/**
* Gets and sets the fill type.
* The value of the property is FillType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setType(value) {
}
/**
* Gets and sets fill type
* The value of the property is FillType integer constant.
*/
getFillType() {
}
/**
* Gets and sets fill type
* The value of the property is FillType integer constant.
*/
setFillType(value) {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets the fill format set type.
* The value of the property is FormatSetType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSetType() {
}
/**
* Gets the fill format set type.
* The value of the property is FormatSetType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use FillFormat.FillType property instead.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSetType(value) {
}
/**
* Gets GradientFill object.
*/
getGradientFill() {
}
/**
* Gets TextureFill object.
*/
getTextureFill() {
}
/**
* Gets SolidFill object.
*/
getSolidFill() {
}
/**
* Gets PatternFill object.
*/
getPatternFill() {
}
/**
* Returns the gradient color type for the specified fill.
* The value of the property is GradientColorType integer constant.
*/
getGradientColorType() {
}
/**
* Returns the gradient style for the specified fill.
* The value of the property is GradientStyleType integer constant.
*/
getGradientStyle() {
}
/**
* Returns the gradient color 1 for the specified fill.
*/
getGradientColor1() {
}
/**
* Returns the gradient color 2 for the specified fill.
* Only when the gradient color type is GradientColorType.TwoColors, this property is meaningful.
*/
getGradientColor2() {
}
/**
* Returns the gradient degree for the specified fill.
* Only applies for Excel 2007.
* Can only be a value from 0.0 (dark) through 1.0 (light).
*/
getGradientDegree() {
}
/**
* Returns the gradient variant for the specified fill.
* Only applies for Excel 2007.
* 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() {
}
/**
* Returns the gradient preset color for the specified fill.
* The value of the property is GradientPresetType integer constant.
*/
getPresetColor() {
}
/**
* Represents the texture type for the specified fill.
* The value of the property is TextureType integer constant.
*/
getTexture() {
}
/**
* Represents the texture type for the specified fill.
* The value of the property is TextureType integer constant.
*/
setTexture(value) {
}
/**
* Represents an area's display pattern.
* The value of the property is FillPattern integer constant.
*/
getPattern() {
}
/**
* Represents an area's display pattern.
* The value of the property is FillPattern integer constant.
*/
setPattern(value) {
}
/**
* Gets and sets the picture format type.
* The value of the property is FillPictureType integer constant.
*/
getPictureFormatType() {
}
/**
* Gets and sets the picture format type.
* The value of the property is FillPictureType integer constant.
*/
setPictureFormatType(value) {
}
/**
* Gets and sets the picture format scale.
*/
getScale() {
}
/**
* Gets and sets the picture format scale.
*/
setScale(value) {
}
/**
* Gets and sets the picture image data.
* If the fill format is not custom texture format, returns null.
*/
getImageData() {
}
/**
* Gets and sets the picture image data.
* If the fill format is not custom texture format, returns null.
*/
setImageData(value) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
/**
* Determines whether this instance has the same value as another specified LineFormat object.
* @param {Object} obj - The
* @return {boolean} 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) {
}
/**
* Sets the specified fill to a one-color gradient.
* Only applies for Excel 2007.
* @param {Color} color - One gradient color.
* @param {Number} degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).
* @param {Number} style - GradientStyleType
* @param {Number} 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, degree, style, variant) {
}
/**
* Sets the specified fill to a two-color gradient.
* Only applies for Excel 2007.
* @param {Color} color1 - One gradient color.
* @param {Color} color2 - Two gradient color.
* @param {Number} style - GradientStyleType
* @param {Number} 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, color2, style, variant) {
}
/**
* Sets the specified fill to a two-color gradient.
* Only applies for Excel 2007.
* @param {Color} color1 - One gradient color.
* @param {Number} transparency1 - The degree of transparency of the color1 as a value from 0.0 (opaque) through 1.0 (clear).
* @param {Color} color2 - Two gradient color.
* @param {Number} transparency2 - The degree of transparency of the color2 as a value from 0.0 (opaque) through 1.0 (clear).
* @param {Number} style - GradientStyleType
* @param {Number} 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, transparency1, color2, transparency2, style, variant) {
}
/**
* Sets the specified fill to a preset-color gradient.
* Only applies for Excel 2007.
* @param {Number} presetColor - GradientPresetType
* @param {Number} style - GradientStyleType
* @param {Number} 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, style, variant) {
}
}
/**
* Represents the line shape.
* @example
* //Instantiate a new Workbook.
* var workbook = new aspose.cells.Workbook();
* //Get the first worksheet in the book.
* var worksheet = workbook.getWorksheets().get(0);
* //Add a new line to the worksheet.
* var line1 = worksheet.getShapes().addShape(aspose.cells.MsoDrawingType.LINE, 5, 0, 1, 0, 0, 250);
* //Set the line dash style
* line1.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Set the placement.
* line1.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Add another line to the worksheet.
* var line2 = worksheet.getShapes().addShape(aspose.cells.MsoDrawingType.LINE, 7, 0, 1, 0, 85, 250);
* //Set the line dash style.
* line2.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.DASH_LONG_DASH);
* //Set the weight of the line.
* line2.getLineFormat().setWeight(4);
* //Set the placement.
* line2.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Add the third line to the worksheet.
* var line3 = worksheet.getShapes().addShape(aspose.cells.MsoDrawingType.LINE, 13, 0, 1, 0, 0, 250);
* //Set the line dash style
* line3.getLineFormat().setDashStyle(aspose.cells.MsoLineDashStyle.SOLID);
* //Set the placement.
* line3.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Make the gridlines invisible in the first worksheet.
* workbook.getWorksheets().get(0).setGridlinesVisible(false);
* //Save the excel file.
* workbook.save("Book1.xls");
* @hideconstructor
*/
class LineShape {
/**
* Gets and sets the begin arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBeginArrowheadStyle() {
}
/**
* Gets and sets the begin arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBeginArrowheadStyle(value) {
}
/**
* Gets and sets the begin arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBeginArrowheadWidth() {
}
/**
* Gets and sets the begin arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBeginArrowheadWidth(value) {
}
/**
* Gets and sets the begin arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBeginArrowheadLength() {
}
/**
* Gets and sets the begin arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.BeginArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBeginArrowheadLength(value) {
}
/**
* Gets and sets the end arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getEndArrowheadStyle() {
}
/**
* Gets and sets the end arrow head style of the line.
* The value of the property is MsoArrowheadStyle integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadStyle property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEndArrowheadStyle(value) {
}
/**
* Gets and sets the end arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getEndArrowheadWidth() {
}
/**
* Gets and sets the end arrow head width of the line.
* The value of the property is MsoArrowheadWidth integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadWidth property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEndArrowheadWidth(value) {
}
/**
* Gets and sets the end arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getEndArrowheadLength() {
}
/**
* Gets and sets the end arrow head length of the line.
* The value of the property is MsoArrowheadLength integer constant.NOTE: This member is now obsolete. Instead,
* please use Shape.Line.EndArrowheadLength property.
* This property will be removed 12 months later since August 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEndArrowheadLength(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a list box object.
* @example
* //Create a new Workbook.
* var workbook = new aspose.cells.Workbook();
* //Get the first worksheet.
* var sheet = workbook.getWorksheets().get(0);
* //Get the worksheet cells collection.
* var cells = sheet.getCells();
* //Input a value.
* cells.get("B3").putValue("Choose Dept:");
* //Set it bold.
* cells.get("B3").getStyle().getFont().setBold(true);
* //Input some values that denote the input range
* //for the list box.
* cells.get("A2").putValue("Sales");
* cells.get("A3").putValue("Finance");
* cells.get("A4").putValue("MIS");
* cells.get("A5").putValue("R&amp;D");
* cells.get("A6").putValue("Marketing");
* cells.get("A7").putValue("HRA");
* //Add a new list box.
* var listBox = sheet.getShapes().addShape(aspose.cells.MsoDrawingType.LIST_BOX, 2, 0, 3, 0, 122, 100);
* //Set the placement type.
* listBox.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Set the linked cell.
* listBox.setLinkedCell("A1");
* //Set the input range.
* listBox.setInputRange("A2:A7");
* //Set the selection tyle.
* listBox.setSelectionType(aspose.cells.SelectionType.SINGLE);
* //Set the list box with 3-D shading.
* listBox.setShadow(true);
* //Saves the file.
* workbook.save("Book1.xls");
* @hideconstructor
*/
class ListBox {
/**
* Gets the number of items in the list box.
*/
getItemCount() {
}
/**
* Gets or sets the index number of the currently selected item in a list box or combo box.
* Zero-based.
* -1 presents no item is selected.
*/
getSelectedIndex() {
}
/**
* Gets or sets the index number of the currently selected item in a list box or combo box.
* Zero-based.
* -1 presents no item is selected.
*/
setSelectedIndex(value) {
}
/**
* Gets the selected cells.
* Returns null if the input range is not set or no item is selected
*/
getSelectedCells() {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
getShadow() {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
setShadow(value) {
}
/**
* Gets or sets the selection mode of the specified list box.
* The value of the property is SelectionType integer constant.
*/
getSelectionType() {
}
/**
* Gets or sets the selection mode of the specified list box.
* The value of the property is SelectionType integer constant.
*/
setSelectionType(value) {
}
/**
* Specifies the amount by which the control's value is changed
* when the user clicks on the scrollbar's page up or page down region.
*/
getPageChange() {
}
/**
* Specifies the amount by which the control's value is changed
* when the user clicks on the scrollbar's page up or page down region.
*/
setPageChange(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Sets whether the item is selected
* @param {Number} itemIndex - The item index
* @param {boolean} isSelected - Whether the item is selected.
* True means that this item should be selected.
* False means that this item should be unselected.
*/
selectedItem(itemIndex, isSelected) {
}
/**
* Indicates whether the item is selected.
* @param {Number} itemIndex - The item index.
* @return {boolean} whether the item is selected.
*/
isSelected(itemIndex) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a ListBox ActiveX control.
* @hideconstructor
*/
class ListBoxActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
* The value of the property is ControlScrollBarType integer constant.
*/
getScrollBars() {
}
/**
* Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
* The value of the property is ControlScrollBarType integer constant.
*/
setScrollBars(value) {
}
/**
* Gets and set the width in unit of points.
*/
getListWidth() {
}
/**
* Gets and set the width in unit of points.
*/
setListWidth(value) {
}
/**
* Represents how the Value property is determined for a ComboBox or ListBox
* when the MultiSelect properties value (fmMultiSelectSingle).
*/
getBoundColumn() {
}
/**
* Represents how the Value property is determined for a ComboBox or ListBox
* when the MultiSelect properties value (fmMultiSelectSingle).
*/
setBoundColumn(value) {
}
/**
* Represents the column in a ComboBox or ListBox to display to the user.
*/
getTextColumn() {
}
/**
* Represents the column in a ComboBox or ListBox to display to the user.
*/
setTextColumn(value) {
}
/**
* Represents the number of columns to display in a ComboBox or ListBox.
*/
getColumnCount() {
}
/**
* Represents the number of columns to display in a ComboBox or ListBox.
*/
setColumnCount(value) {
}
/**
* Indicates how a ListBox or ComboBox searches its list as the user types.
* The value of the property is ControlMatchEntryType integer constant.
*/
getMatchEntry() {
}
/**
* Indicates how a ListBox or ComboBox searches its list as the user types.
* The value of the property is ControlMatchEntryType integer constant.
*/
setMatchEntry(value) {
}
/**
* Gets and sets the visual appearance.
* The value of the property is ControlListStyle integer constant.
*/
getListStyle() {
}
/**
* Gets and sets the visual appearance.
* The value of the property is ControlListStyle integer constant.
*/
setListStyle(value) {
}
/**
* Indicates whether the control permits multiple selections.
* The value of the property is SelectionType integer constant.
*/
getSelectionType() {
}
/**
* Indicates whether the control permits multiple selections.
* The value of the property is SelectionType integer constant.
*/
setSelectionType(value) {
}
/**
* Gets and sets the value of the control.
* Only effects when SelectionType is SelectionType.Single;
*/
getValue() {
}
/**
* Gets and sets the value of the control.
* Only effects when SelectionType is SelectionType.Single;
*/
setValue(value) {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
getBorderStyle() {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
setBorderStyle(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBorderOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBorderOleColor(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Indicates whether column headings are displayed.
*/
getShowColumnHeads() {
}
/**
* Indicates whether column headings are displayed.
*/
setShowColumnHeads(value) {
}
/**
* Indicates whether the control will only show complete lines of text without showing any partial lines.
*/
getIntegralHeight() {
}
/**
* Indicates whether the control will only show complete lines of text without showing any partial lines.
*/
setIntegralHeight(value) {
}
/**
* Gets and sets the width of the column.
*/
getColumnWidths() {
}
/**
* Gets and sets the width of the column.
*/
setColumnWidths(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Represents a column in a Table.
* @hideconstructor
*/
class ListColumn {
/**
* Gets and sets the name of the column.
* If sets the name of the column, the according cell' value will be changed too.
*/
getName() {
}
/**
* Gets and sets the name of the column.
* If sets the name of the column, the according cell' value will be changed too.
*/
setName(value) {
}
/**
* Gets and sets the type of calculation in the Totals row of the list column.
* The value of the property is TotalsCalculation integer constant.
*/
getTotalsCalculation() {
}
/**
* Gets and sets the type of calculation in the Totals row of the list column.
* The value of the property is TotalsCalculation integer constant.
*/
setTotalsCalculation(value) {
}
/**
* Gets the range of this list column.
*/
getRange() {
}
/**
* Gets and sets the formula of the list column.
*/
getFormula() {
}
/**
* Gets and sets the formula of the list column.
*/
setFormula(value) {
}
/**
* Gets and sets the display labels of total row.
*/
getTotalsRowLabel() {
}
/**
* Gets and sets the display labels of total row.
*/
setTotalsRowLabel(value) {
}
/**
* Gets the formula of totals row of this list column.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The formula of this list column.
*/
getCustomTotalsRowFormula(isR1C1, isLocal) {
}
/**
* Gets the formula of totals row of this list column.
* @param {String} formula - the formula for this list column.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setCustomTotalsRowFormula(formula, isR1C1, isLocal) {
}
/**
* Gets the formula of this list column.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The formula of this list column.
*/
getCustomCalculatedFormula(isR1C1, isLocal) {
}
/**
* Sets the formula for this list column.
* @param {String} formula - the formula for this list column.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setCustomCalculatedFormula(formula, isR1C1, isLocal) {
}
/**
* Gets the style of the data in this column of the table.
*/
getDataStyle() {
}
/**
* Sets the style of the data in this column of the table.
*/
setDataStyle(style) {
}
}
/**
* Represents A collection of all the ListColumn objects in the specified ListObject object.
* @hideconstructor
*/
class ListColumnCollection {
/**
*/
getCount() {
}
/**
* Gets the ListColumn by the index.
* @param {Number} index - The index.
* @return {ListColumn} the ListColumn object.
*/
get(index) {
}
/**
* Gets the ListColumn by the name.
* @param {String} name - The name of the ListColumn
* @return {ListColumn} The ListColumn object.
*/
get(name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a list object on a worksheet.
* The ListObject object is a member of the ListObjects collection.
* The ListObjects collection contains all the list objects on a worksheet.
* @example
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* for (var i = 0; i < 5; i++)
* {
* cells.get(0, i).putValue(aspose.cells.CellsHelper.columnIndexToName(i));
* }
* for (var row = 1; row < 10; row++)
* {
* for (var column = 0; column < 5; column++)
* {
* cells.get(row, column).putValue(row * column);
* }
* }
* var tables = workbook.getWorksheets().get(0).getListObjects();
* var index = tables.add(0, 0, 9, 4, true);
* var table = tables.get(0);
* table.setShowTotals(true);
* table.getListColumns().get(4).setTotalsCalculation(aspose.cells.TotalsCalculation.SUM);
* workbook.save("Book1.xlsx");
* @hideconstructor
*/
class ListObject {
/**
* Gets the start row of the range.
*/
getStartRow() {
}
/**
* Gets the start column of the range.
*/
getStartColumn() {
}
/**
* Gets the end row of the range.
*/
getEndRow() {
}
/**
* Gets the end column of the range.
*/
getEndColumn() {
}
/**
* Gets ListColumns of the ListObject.
*/
getListColumns() {
}
/**
* Gets and sets whether this ListObject show header row.
*/
getShowHeaderRow() {
}
/**
* Gets and sets whether this ListObject show header row.
*/
setShowHeaderRow(value) {
}
/**
* Gets and sets whether this ListObject show total row.
*/
getShowTotals() {
}
/**
* Gets and sets whether this ListObject show total row.
*/
setShowTotals(value) {
}
/**
* Gets the data range of the ListObject.
*/
getDataRange() {
}
/**
* Gets the linked QueryTable.
*/
getQueryTable() {
}
/**
* Gets the data source type of the table.
* The value of the property is TableDataSourceType integer constant.
*/
getDataSourceType() {
}
/**
* Gets auto filter.
*/
getAutoFilter() {
}
/**
* Gets and sets the display name.
*/
getDisplayName() {
}
/**
* Gets and sets the display name.
*/
setDisplayName(value) {
}
/**
* Gets and sets the comment of the table.
*/
getComment() {
}
/**
* Gets and sets the comment of the table.
*/
setComment(value) {
}
/**
* Indicates whether the first column in the table should have the style applied.
*/
getShowTableStyleFirstColumn() {
}
/**
* Indicates whether the first column in the table should have the style applied.
*/
setShowTableStyleFirstColumn(value) {
}
/**
* Indicates whether the last column in the table should have the style applied.
*/
getShowTableStyleLastColumn() {
}
/**
* Indicates whether the last column in the table should have the style applied.
*/
setShowTableStyleLastColumn(value) {
}
/**
* Indicates whether row stripe formatting is applied.
*/
getShowTableStyleRowStripes() {
}
/**
* Indicates whether row stripe formatting is applied.
*/
setShowTableStyleRowStripes(value) {
}
/**
* Indicates whether column stripe formatting is applied.
*/
getShowTableStyleColumnStripes() {
}
/**
* Indicates whether column stripe formatting is applied.
*/
setShowTableStyleColumnStripes(value) {
}
/**
* Gets and the built-in table style.
* The value of the property is TableStyleType integer constant.
*/
getTableStyleType() {
}
/**
* Gets and the built-in table style.
* The value of the property is TableStyleType integer constant.
*/
setTableStyleType(value) {
}
/**
* Gets and sets the table style name.
*/
getTableStyleName() {
}
/**
* Gets and sets the table style name.
*/
setTableStyleName(value) {
}
/**
* Gets an XmlMap used for this list.
*/
getXmlMap() {
}
/**
* Gets and sets the alternative text.
*/
getAlternativeText() {
}
/**
* Gets and sets the alternative text.
*/
setAlternativeText(value) {
}
/**
* Gets and sets the alternative description.
*/
getAlternativeDescription() {
}
/**
* Gets and sets the alternative description.
*/
setAlternativeDescription(value) {
}
/**
* Resize the range of the list object.
* @param {Number} startRow - The start row index of the new range.
* @param {Number} startColumn - The start column index of the new range.
* @param {Number} endRow - The end row index of the new range.
* @param {Number} endColumn - The end column index of the new range.
* @param {boolean} hasHeaders - Whether this table has headers.
*/
resize(startRow, startColumn, endRow, endColumn, hasHeaders) {
}
/**
* Put the value to the cell.
* @param {Number} rowOffset - The row offset in the table.
* @param {Number} columnOffset - The column offset in the table.
* @param {Object} value - The cell value.
*/
putCellValue(rowOffset, columnOffset, value) {
}
/**
* Put the value to the cell.
* @param {Number} rowOffset - The row offset in the table.
* @param {Number} columnOffset - The column offset in the table.
* @param {Object} value - The cell value.
* @param {boolean} 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, columnOffset, value, isTotalsRowLabel) {
}
/**
* Put the formula to the cell in the table.
* @param {Number} rowOffset - The row offset in the table.
* @param {Number} columnOffset - The column offset in the table.
* @param {String} formula - The formula of the cell.
*/
putCellFormula(rowOffset, columnOffset, formula) {
}
/**
* Put the formula to the cell in the table.
* @param {Number} rowOffset - The row offset in the table.
* @param {Number} columnOffset - The column offset in the table.
* @param {String} formula - The formula of the cell.
* @param {boolean} isTotalsRowFormula
*/
putCellFormula(rowOffset, columnOffset, formula, isTotalsRowFormula) {
}
/**
* Updates all list columns' name from the worksheet.
* 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() {
}
/**
* Filter the table.
*/
filter() {
}
/**
* Apply the table style to the range.
*/
applyStyleToRange() {
}
/**
* Convert the table to range.
*/
convertToRange() {
}
/**
* Convert the table to range.
* @param {TableToRangeOptions} options - the options when converting table to range.
*/
convertToRange(options) {
}
}
/**
* Represents a collection of ListObject objects in the worksheet.
* @hideconstructor
*/
class ListObjectCollection {
/**
*/
getCount() {
}
/**
* Gets the ListObject by index.
* @param {Number} index - The index.
* @return {ListObject} The ListObject
*/
get(index) {
}
/**
* Gets the ListObject by specified name.
* @param {String} tableName - ListObject name.
* @return {ListObject} The ListObject
*/
get(tableName) {
}
/**
* Adds a ListObject to the worksheet.
* @param {Number} startRow - The start row of the list range.
* @param {Number} startColumn - The start row of the list range.
* @param {Number} endRow - The start row of the list range.
* @param {Number} endColumn - The start row of the list range.
* @param {boolean} hasHeaders - Whether the range has headers.
* @return {Number} The index of the new ListObject
*/
add(startRow, startColumn, endRow, endColumn, hasHeaders) {
}
/**
* Adds a ListObject to the worksheet.
* @param {String} startCell - The start cell of the list range.
* @param {String} endCell - The end cell of the list range.
* @param {boolean} hasHeaders - Whether the range has headers.
* @return {Number} The index of the new ListObject
*/
add(startCell, endCell, hasHeaders) {
}
/**
* Update all column name of the tables.
*/
updateColumnName() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the filter that provides options for loading data when loading workbook from template.
* User may specify the filter options or implement their own LoadFilter to specify how to load data.
*/
class LoadFilter {
/**
* Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.
*/
constructor() {
}
/**
* Constructs one LoadFilter with given filter options.
* @param {Number} opts - LoadDataFilterOptions
*/
constructor_overload$1(opts) {
}
/**
* The filter options to denote what data should be loaded.
* The value of the property is LoadDataFilterOptions integer constant.
*/
getLoadDataFilterOptions() {
}
/**
* The filter options to denote what data should be loaded.
* The value of the property is LoadDataFilterOptions integer constant.
*/
setLoadDataFilterOptions(value) {
}
/**
* 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() {
}
/**
* 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 {Worksheet} 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) {
}
}
/**
* Represents the options of loading the file.
*/
class LoadOptions {
/**
* Creates an options of loading the file.
*/
constructor() {
}
/**
* Creates an options of loading the file.
* @param {Number} loadFormat - LoadFormat
*/
constructor_overload$1(loadFormat) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents the save options for markdown.
*/
class MarkdownSaveOptions {
/**
* Creates options for saving markdown document
*/
constructor() {
}
/**
* Gets and sets the default encoding.
*/
getEncoding() {
}
/**
* Gets and sets the default encoding.
*/
setEncoding(value) {
}
/**
* Gets and sets the format strategy when exporting the cell value as string.
* The value of the property is CellValueFormatStrategy integer constant.
*/
getFormatStrategy() {
}
/**
* Gets and sets the format strategy when exporting the cell value as string.
* The value of the property is CellValueFormatStrategy integer constant.
*/
setFormatStrategy(value) {
}
/**
* The Data provider to provide cells data for saving workbook in light mode.
*/
getLightCellsDataProvider() {
}
/**
* The Data provider to provide cells data for saving workbook in light mode.
*/
setLightCellsDataProvider(value) {
}
/**
* Gets and sets the line separator.
*/
getLineSeparator() {
}
/**
* Gets and sets the line separator.
*/
setLineSeparator(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents the marker in a line chart, scatter chart, or radar chart.
* @hideconstructor
*/
class Marker {
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the Area.
*/
getArea() {
}
/**
* Represents the marker style. Applies to line chart, scatter chart, or radar chart.
* The value of the property is ChartMarkerType integer constant.
*/
getMarkerStyle() {
}
/**
* Represents the marker style. Applies to line chart, scatter chart, or radar chart.
* The value of the property is ChartMarkerType integer constant.
*/
setMarkerStyle(value) {
}
/**
* Represents the marker size in unit of points. Applies to line chart, scatter chart, or radar chart.
*/
getMarkerSize() {
}
/**
* Represents the marker size in unit of points. Applies to line chart, scatter chart, or radar chart.
*/
setMarkerSize(value) {
}
/**
* Represents the marker size in unit of pixels. Applies to line chart, scatter chart, or radar chart.
*/
getMarkerSizePx() {
}
/**
* Represents the marker size in unit of pixels. Applies to line chart, scatter chart, or radar chart.
*/
setMarkerSizePx(value) {
}
/**
* Represents the marker foreground color in a line chart, scatter chart, or radar chart.
*/
getForegroundColor() {
}
/**
* Represents the marker foreground color in a line chart, scatter chart, or radar chart.
*/
setForegroundColor(value) {
}
/**
* Gets or sets the marker foreground color set type.
* The value of the property is FormattingType integer constant.
*/
getForegroundColorSetType() {
}
/**
* Gets or sets the marker foreground color set type.
* The value of the property is FormattingType integer constant.
*/
setForegroundColorSetType(value) {
}
/**
* Represents the marker background color in a line chart, scatter chart, or radar chart.
*/
getBackgroundColor() {
}
/**
* Represents the marker background color in a line chart, scatter chart, or radar chart.
*/
setBackgroundColor(value) {
}
/**
* Gets or sets the marker background color set type.
* The value of the property is FormattingType integer constant.
*/
getBackgroundColorSetType() {
}
/**
* Gets or sets the marker background color set type.
* The value of the property is FormattingType integer constant.
*/
setBackgroundColorSetType(value) {
}
}
/**
* This class specifies an equation or mathematical expression. All mathematical text of equations or mathematical expressions are contained by this class.
* @hideconstructor
*/
class MathematicalEquationNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* This class specifies the Matrix equation, consisting of one or more elements laid out in one or more rows and one or more columns.
* @hideconstructor
*/
class MatrixEquationNode {
/**
* 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.
* The value of the property is EquationVerticalJustificationType integer constant.
*/
getBaseJc() {
}
/**
* 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.
* The value of the property is EquationVerticalJustificationType integer constant.
*/
setBaseJc(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setHidePlaceholder(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents the single TrueType font file stored in memory.
*/
class MemoryFontSource {
/**
* Ctor.
* @param {byte[]} fontData - Binary font data.
*/
constructor(fontData) {
}
/**
* Binary font data.
*/
getFontData() {
}
/**
* Returns the type of the font source.
* The value of the property is FontSourceType integer constant.
*/
getType() {
}
}
/**
* Represents the options of loading metadata of the file.
*/
class MetadataOptions {
/**
* Creates an options of loading the metadata.
* @param {Number} metadataType - MetadataType
*/
constructor(metadataType) {
}
/**
* Gets and sets the type of the metadata which is loading.
* The value of the property is MetadataType integer constant.
*/
getMetadataType() {
}
/**
* Represents Workbook file encryption password.
*/
getPassword() {
}
/**
* Represents Workbook file encryption password.
*/
setPassword(value) {
}
/**
* The key length.
*/
getKeyLength() {
}
/**
* The key length.
*/
setKeyLength(value) {
}
}
/**
* Provides methods to set metered key.
*/
class Metered {
/**
* Initializes a new instance of this class.
*/
constructor() {
}
/**
* Sets metered public and private key.
* If you purchase metered license, when start application, this API should be called, normally, this is enough.
* However, if always fail to upload consumption data and exceed 24 hours, the license will be set to evaluation status,
* to avoid such case, you should regularly check the license status, if it is evaluation status, call this API again.
* @param {String} publicKey - public key
* @param {String} privateKey - private key
*/
setMeteredKey(publicKey, privateKey) {
}
/**
* Gets consumption file size
* @return {Number} consumption quantity
*/
static getConsumptionQuantity() {
}
/**
* Gets consumption credit
* @return {Number} consumption quantity
*/
static getConsumptionCredit() {
}
/**
* Check whether metered is licensed
* @return {boolean} True or false
*/
static isMeteredLicensed() {
}
}
/**
* Represents fill formatting for a shape.
* @hideconstructor
*/
class MsoFillFormat {
/**
* Gets and sets the fill fore color.
*/
getForeColor() {
}
/**
* Gets and sets the fill fore color.
*/
setForeColor(value) {
}
/**
* Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets and sets the file back color.
*/
getBackColor() {
}
/**
* Gets and sets the file back color.
*/
setBackColor(value) {
}
/**
* Gets and sets the Texture and Picture fill data.
*/
getImageData() {
}
/**
* Gets and sets the Texture and Picture fill data.
*/
setImageData(value) {
}
/**
* Gets the texture fill type.
* The value of the property is TextureType integer constant.
*/
getTexture() {
}
/**
* Indicates whether there is fill.
*/
isVisible() {
}
/**
* Indicates whether there is fill.
*/
setVisible(value) {
}
/**
* Sets the specified fill to a one-color gradient.
* @param {Color} color - One gradient color.
* @param {Number} degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).
* @param {Number} style - GradientStyleType
* @param {Number} 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, degree, style, variant) {
}
}
/**
* Represents fill formatting for a shape.
* @hideconstructor
*/
class MsoFillFormatHelper {
/**
* Gets and sets the fill fore color.
*/
getForeColor() {
}
/**
* Gets and sets the fill fore color.
*/
setForeColor(value) {
}
/**
* Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
getForeColorTransparency() {
}
/**
* Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
setForeColorTransparency(value) {
}
/**
* Gets and sets the file back color.
*/
getBackColor() {
}
/**
* Gets and sets the file back color.
*/
setBackColor(value) {
}
/**
* Gets and sets the Texture and Picture fill data.
*/
getImageData() {
}
/**
* Gets and sets the Texture and Picture fill data.
*/
setImageData(value) {
}
/**
* Gets the texture fill type.
* The value of the property is TextureType integer constant.
*/
getTexture() {
}
/**
* Indicates whether there is fill.
*/
isVisible() {
}
/**
* Indicates whether there is fill.
*/
setVisible(value) {
}
/**
* Sets the specified fill to a one-color gradient.
* @param {Color} color - One gradient color.
* @param {Number} degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).
* @param {Number} style - GradientStyleType
* @param {Number} 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, degree, style, variant) {
}
}
/**
* Represents the picture format.
* @hideconstructor
*/
class MsoFormatPicture {
/**
* Represents the location of the top of the crop rectangle expressed, in unit of inches.
*/
getTopCropInch() {
}
/**
* Represents the location of the top of the crop rectangle expressed, in unit of inches.
*/
setTopCropInch(value) {
}
/**
* Represents the location of the bottom of the crop rectangle expressed, in unit of inches.
*/
getBottomCropInch() {
}
/**
* Represents the location of the bottom of the crop rectangle expressed, in unit of inches.
*/
setBottomCropInch(value) {
}
/**
* Represents the location of the left of the crop rectangle expressed, in unit of inches.
*/
getLeftCropInch() {
}
/**
* Represents the location of the left of the crop rectangle expressed, in unit of inches.
*/
setLeftCropInch(value) {
}
/**
* Represents the location of the right of the crop rectangle expressed, in unit of inches.
*/
getRightCropInch() {
}
/**
* Represents the location of the right of the crop rectangle expressed, in unit of inches.
*/
setRightCropInch(value) {
}
/**
* Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height.
*/
getTopCrop() {
}
/**
* Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height.
*/
setTopCrop(value) {
}
/**
* Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height.
*/
getBottomCrop() {
}
/**
* Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height.
*/
setBottomCrop(value) {
}
/**
* Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width.
*/
getLeftCrop() {
}
/**
* Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width.
*/
setLeftCrop(value) {
}
/**
* Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width.
*/
getRightCrop() {
}
/**
* Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width.
*/
setRightCrop(value) {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets and sets the transparent color of the picture.
*/
getTransparentColor() {
}
/**
* Gets and sets the transparent color of the picture.
*/
setTransparentColor(value) {
}
/**
* Represents the contrast modification for the picture.in unit of percentage.
* It is between -100% and 100%. It works same as Excel 2007 or above version.
*/
getContrast() {
}
/**
* Represents the contrast modification for the picture.in unit of percentage.
* It is between -100% and 100%. It works same as Excel 2007 or above version.
*/
setContrast(value) {
}
/**
* Represents the brightness modification for the picture in unit of percentage.
* It is between -100% and 100%. It works same as Excel 2007 or above version.
*/
getBrightness() {
}
/**
* Represents the brightness modification for the picture in unit of percentage.
* It is between -100% and 100%. It works same as Excel 2007 or above version.
*/
setBrightness(value) {
}
/**
* Represents gamma of the picture.
*/
getGamma() {
}
/**
* Represents gamma of the picture.
*/
setGamma(value) {
}
/**
* Indicates whether this picture should display in two-color black and white.
*/
isBiLevel() {
}
/**
* Indicates whether this picture should display in two-color black and white.
*/
setBiLevel(value) {
}
/**
* Indicates whether this picture should display in grayscale.
*/
isGray() {
}
/**
* Indicates whether this picture should display in grayscale.
*/
setGray(value) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
/**
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
}
/**
* Represents line and arrowhead formatting.
* @hideconstructor
*/
class MsoLineFormat {
/**
* Indicates whether the object is visible.
*/
isVisible() {
}
/**
* Indicates whether the object is visible.
*/
setVisible(value) {
}
/**
* Returns a Style object that represents the style of the specified range.
* The value of the property is MsoLineStyle integer constant.
*/
getStyle() {
}
/**
* Returns a Style object that represents the style of the specified range.
* The value of the property is MsoLineStyle integer constant.
*/
setStyle(value) {
}
/**
* Gets and sets the border line fore color.
*/
getForeColor() {
}
/**
* Gets and sets the border line fore color.
*/
setForeColor(value) {
}
/**
* Gets and sets the border line back color.
*/
getBackColor() {
}
/**
* Gets and sets the border line back color.
*/
setBackColor(value) {
}
/**
* Gets or sets the dash style for the specified line.
* The value of the property is MsoLineDashStyle integer constant.
*/
getDashStyle() {
}
/**
* Gets or sets the dash style for the specified line.
* The value of the property is MsoLineDashStyle integer constant.
*/
setDashStyle(value) {
}
/**
* Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Returns or sets the weight of the line ,in units of pt.
*/
getWeight() {
}
/**
* Returns or sets the weight of the line ,in units of pt.
*/
setWeight(value) {
}
}
/**
* Represents line and arrowhead formatting.
* @hideconstructor
*/
class MsoLineFormatHelper {
/**
* Indicates whether the object is visible.
*/
isVisible() {
}
/**
* Indicates whether the object is visible.
*/
setVisible(value) {
}
/**
* Returns a Style object that represents the style of the specified range.
* The value of the property is MsoLineStyle integer constant.
*/
getStyle() {
}
/**
* Returns a Style object that represents the style of the specified range.
* The value of the property is MsoLineStyle integer constant.
*/
setStyle(value) {
}
/**
* Gets and sets the border line fore color.
*/
getForeColor() {
}
/**
* Gets and sets the border line fore color.
*/
setForeColor(value) {
}
/**
* Gets and sets the border line back color.
*/
getBackColor() {
}
/**
* Gets and sets the border line back color.
*/
setBackColor(value) {
}
/**
* Gets or sets the dash style for the specified line.
* The value of the property is MsoLineDashStyle integer constant.
*/
getDashStyle() {
}
/**
* Gets or sets the dash style for the specified line.
* The value of the property is MsoLineDashStyle integer constant.
*/
setDashStyle(value) {
}
/**
* Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Returns or sets the weight of the line ,in units of pt.
*/
getWeight() {
}
/**
* Returns or sets the weight of the line ,in units of pt.
*/
setWeight(value) {
}
}
/**
* Represents the text frame in a Shape object.
* @hideconstructor
*/
class MsoTextFrame {
/**
* Indicates if size of shape is adjusted automatically according to its content.
*/
getAutoSize() {
}
/**
* Indicates if size of shape is adjusted automatically according to its content.
*/
setAutoSize(value) {
}
/**
* Indicates whether the margin is auto calculated.
*/
isAutoMargin() {
}
/**
* Indicates whether the margin is auto calculated.
*/
setAutoMargin(value) {
}
/**
* Indicates whether rotating text with shape.
*/
getRotateTextWithShape() {
}
/**
* Indicates whether rotating text with shape.
*/
setRotateTextWithShape(value) {
}
/**
* Returns the left margin in unit of Points
*/
getLeftMarginPt() {
}
/**
* Returns the left margin in unit of Points
*/
setLeftMarginPt(value) {
}
/**
* Returns the right margin in unit of Points
*/
getRightMarginPt() {
}
/**
* Returns the right margin in unit of Points
*/
setRightMarginPt(value) {
}
/**
* Returns the top margin in unit of Points
*/
getTopMarginPt() {
}
/**
* Returns the top margin in unit of Points
*/
setTopMarginPt(value) {
}
/**
* Returns the bottom margin in unit of Points
*/
getBottomMarginPt() {
}
/**
* Returns the bottom margin in unit of Points
*/
setBottomMarginPt(value) {
}
}
/**
* Represents the multiple filter collection.
*/
class MultipleFilterCollection {
/**
* Constructs one new instance.
*/
constructor() {
}
/**
* Indicates whether to filter by blank.
*/
getMatchBlank() {
}
/**
* Indicates whether to filter by blank.
*/
setMatchBlank(value) {
}
/**
*/
getCount() {
}
/**
* DateTimeGroupItem or a simple object.
* @param {Number} index
* @return {Object}
*/
get(index) {
}
/**
* Adds string filter.
* @param {String} filter - The filter data.
*/
add(filter) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a defined name for a range of cells.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Accessing the first worksheet in the Excel file
* var worksheet = workbook.getWorksheets().get(0);
* //Creating a named range
* var range = worksheet.getCells().createRange("B4", "G14");
* //Setting the name of the named range
* range.setName("TestRange");
* //Saving the modified Excel file in default (that is Excel 2000) format
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Name {
/**
* Gets and sets the comment of the name.
* Only applies for Excel 2007 or higher versions.
*/
getComment() {
}
/**
* Gets and sets the comment of the name.
* Only applies for Excel 2007 or higher versions.
*/
setComment(value) {
}
/**
* Gets the name text of the object.
*/
getText() {
}
/**
* Gets the name text of the object.
*/
setText(value) {
}
/**
* Gets the name full text of the object with the scope setting.
*/
getFullText() {
}
/**
* Returns or sets the formula that the name is defined to refer to, beginning with an equal sign.
*/
getRefersTo() {
}
/**
* Returns or sets the formula that the name is defined to refer to, beginning with an equal sign.
*/
setRefersTo(value) {
}
/**
* Gets or sets a R1C1 reference of the Name.
*/
getR1C1RefersTo() {
}
/**
* Gets or sets a R1C1 reference of the Name.
*/
setR1C1RefersTo(value) {
}
/**
* Indicates whether this name is referred by other formulas.
*/
isReferred() {
}
/**
* Indicates whether the name is visible.
*/
isVisible() {
}
/**
* Indicates whether the name is visible.
*/
setVisible(value) {
}
/**
* Indicates this name belongs to Workbook or Worksheet.
* 0 = Global name, otherwise index to sheet (one-based)
*/
getSheetIndex() {
}
/**
* Indicates this name belongs to Workbook or Worksheet.
* 0 = Global name, otherwise index to sheet (one-based)
*/
setSheetIndex(value) {
}
/**
* Get the reference of this Name.
* @param {boolean} isR1C1 - Whether the reference needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the reference needs to be formatted by locale.
*/
getRefersTo(isR1C1, isLocal) {
}
/**
* Get the reference of this Name based on specified cell.
* @param {boolean} isR1C1 - Whether the reference needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the reference needs to be formatted by locale.
* @param {Number} row - The row index of the cell.
* @param {Number} column - The column index of the cell.
*/
getRefersTo(isR1C1, isLocal, row, column) {
}
/**
* Set the reference of this Name.
* @param {String} refersTo - The reference.
* @param {boolean} isR1C1 - Whether the reference is R1C1 format.
* @param {boolean} isLocal - Whether the reference is locale formatted.
*/
setRefersTo(refersTo, isR1C1, isLocal) {
}
/**
* Returns a string represents the current Range object.
* @return {String}
*/
toString() {
}
/**
* Gets all ranges referred by this name.
* @return {Range[]} All ranges.
*/
getRanges() {
}
/**
* Gets all ranges referred by this name.
* @param {boolean} recalculate - whether recalculate it if this name has been calculated before this invocation.
* @return {Range[]} All ranges.
*/
getRanges(recalculate) {
}
/**
* Gets all references referred by this name.
* @param {boolean} recalculate - whether recalculate it if this name has been calculated before this invocation.
* @return {ReferredArea[]} All ranges.
*/
getReferredAreas(recalculate) {
}
/**
* Gets the range if this name refers to a range.
* @return {Range} The range.
*/
getRange() {
}
/**
* Gets the range if this name refers to a range
* @param {boolean} recalculate - whether recalculate it if this name has been calculated before this invocation.
* @return {Range} The range.
*/
getRange(recalculate) {
}
/**
* Gets the range if this name refers to a range.
* If the reference of this name is not absolute, the range may be different for different cell.
* @param {Number} sheetIndex - The according sheet index.
* @param {Number} row - The according row index.
* @param {Number} column - The according column index
* @return {Range} The range.
*/
getRange(sheetIndex, row, column) {
}
}
/**
* Represents a collection of all the Name objects in the spreadsheet.
* @hideconstructor
*/
class NameCollection {
/**
*/
getCount() {
}
/**
* Gets the Name element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Name} The element at the specified index.
*/
get(index) {
}
/**
* Gets the Name element with the specified name.
* @param {String} text - Name text.
* @return {Name} The element with the specified name.
*/
get(text) {
}
/**
* Defines a new name.
* Name cannot include spaces and cannot look like cell references.
* @param {String} text - The text to use as the name.
* @return {Number} Name object index.
*/
add(text) {
}
/**
* Gets all defined name by scope.
* @param {Number} type - NameScopeType
* @param {Number} sheetIndex -
* The sheet index.
* Only effects when scope type is
* @return {Name[]}
*/
filter(type, sheetIndex) {
}
/**
* Remove an array of name
* @param {String[]} names - The names' text.
*/
remove(names) {
}
/**
* Remove the name.
* @param {String} text - The name text.
*/
remove(text) {
}
/**
* Remove the name at the specific index.
* Please make sure that the name is not referred by the other formulas before calling the method.
* And if the name is referred, setting Name.RefersTo as null is better.
* @param {Number} index - index of the Name to be removed.
*/
removeAt(index) {
}
/**
* Remove all defined names which are not referenced by the formulas and data source.
* If the defined name is referred, we only set Name.ReferTo as null and hide them.
*/
clear() {
}
/**
* Remove the duplicate defined names
*/
removeDuplicateNames() {
}
/**
* Sorts defined names.
* 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
*/
sort() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* This class specifies an n-ary operator equation consisting of an n-ary operator, a base (or operand), and optional upper and lower bounds.
* @hideconstructor
*/
class NaryEquationNode {
/**
* Whether to display the lower bound
*/
isHideSubscript() {
}
/**
* Whether to display the lower bound
*/
setHideSubscript(value) {
}
/**
* Whether to display the upper bound
*/
isHideSuperscript() {
}
/**
* Whether to display the upper bound
*/
setHideSuperscript(value) {
}
/**
* 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.
* The value of the property is EquationLimitLocationType integer constant.
*/
getLimitLocation() {
}
/**
* 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.
* The value of the property is EquationLimitLocationType integer constant.
*/
setLimitLocation(value) {
}
/**
* 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.
* 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() {
}
/**
* 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.
* 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) {
}
/**
* an n-ary operator.e.g "∑"
* The value of the property is EquationMathematicalOperatorType integer constant.
*/
getNaryOperatorType() {
}
/**
* an n-ary operator.e.g "∑"
* The value of the property is EquationMathematicalOperatorType integer constant.
*/
setNaryOperatorType(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setNaryGrow(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents the color settings of the data bars for negative values that are defined by a data bar conditional formatting rule.
* @hideconstructor
*/
class NegativeBarFormat {
/**
* Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.
*/
getBorderColor() {
}
/**
* Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.
*/
setBorderColor(value) {
}
/**
* Gets whether to use the same border color as positive data bars.
* The value of the property is DataBarNegativeColorType integer constant.
*/
getBorderColorType() {
}
/**
* Gets whether to use the same border color as positive data bars.
* The value of the property is DataBarNegativeColorType integer constant.
*/
setBorderColorType(value) {
}
/**
* Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.
*/
getColor() {
}
/**
* Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.
*/
setColor(value) {
}
/**
* Gets or sets whether to use the same fill color as positive data bars.
* The value of the property is DataBarNegativeColorType integer constant.
*/
getColorType() {
}
/**
* Gets or sets whether to use the same fill color as positive data bars.
* The value of the property is DataBarNegativeColorType integer constant.
*/
setColorType(value) {
}
}
/**
* Represents no bullet.
*/
class NoneBulletValue {
/**
*/
constructor() {
}
/**
* Gets the type of the bullet's value.
* The value of the property is BulletType integer constant.
*/
getType() {
}
}
/**
* Represents no fill.
* @hideconstructor
*/
class NoneFill {
/**
* /
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* Represents the options of loading Apple Numbers files.
*/
class NumbersLoadOptions {
/**
* Constructor.
*/
constructor() {
}
/**
* Gets and sets the type of loading multiple tables in one worksheet.
* The value of the property is LoadNumbersTableType integer constant.
*/
getLoadTableType() {
}
/**
* Gets and sets the type of loading multiple tables in one worksheet.
* The value of the property is LoadNumbersTableType integer constant.
*/
setLoadTableType(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents the cell field of ods.
* @hideconstructor
*/
class OdsCellField {
/**
* Represents the custom format of the field's value.
*/
getCustomFormat() {
}
/**
* Represents the custom format of the field's value.
*/
setCustomFormat(value) {
}
/**
* Gets and sets the type of the field.
* The value of the property is OdsCellFieldType integer constant.
*/
getFieldType() {
}
/**
* Gets and sets the type of the field.
* The value of the property is OdsCellFieldType integer constant.
*/
setFieldType(value) {
}
/**
* Get and sets the row index of the cell.
*/
getRow() {
}
/**
* Get and sets the row index of the cell.
*/
setRow(value) {
}
/**
* Get and sets the column index of the cell.
*/
getColumn() {
}
/**
* Get and sets the column index of the cell.
*/
setColumn(value) {
}
}
/**
* Represents the fields of ODS.
* @hideconstructor
*/
class OdsCellFieldCollection {
/**
*/
getCount() {
}
/**
* Gets the field by the index.
* @param {Number} index - The index.
* @return {OdsCellField}
*/
get(index) {
}
/**
* Gets the field by row and column index.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {OdsCellField}
*/
get(row, column) {
}
/**
* Adds a field.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @param {Number} fieldType - OdsCellFieldType
* @param {String} format - The number format of the field.
* @return {Number}
*/
add(row, column, fieldType, format) {
}
/**
* Update fields value to the cells.
*/
updateFieldsValue() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the options of loading ods file.
*/
class OdsLoadOptions {
/**
* Represents the options of loading ods file.
*/
constructor() {
}
/**
* Represents the options of loading ods file.
* @param {Number} type - LoadFormat
*/
constructor_overload$1(type) {
}
/**
* Indicates whether applying the default style of the Excel to hyperlink.
*/
getApplyExcelDefaultStyleToHyperlink() {
}
/**
* Indicates whether applying the default style of the Excel to hyperlink.
*/
setApplyExcelDefaultStyleToHyperlink(value) {
}
/**
* Indicates whether refresh pivot tables when loading file.
*/
getRefreshPivotTables() {
}
/**
* Indicates whether refresh pivot tables when loading file.
*/
setRefreshPivotTables(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents the page background of ods.
*/
class OdsPageBackground {
/**
*/
constructor() {
}
/**
* Gets and sets the page background type.
* The value of the property is OdsPageBackgroundType integer constant.
*/
getType() {
}
/**
* Gets and sets the page background type.
* The value of the property is OdsPageBackgroundType integer constant.
*/
setType(value) {
}
/**
* Gets and sets the color of background.
*/
getColor() {
}
/**
* Gets and sets the color of background.
*/
setColor(value) {
}
/**
* Gets and sets the page background graphic type.
* The value of the property is OdsPageBackgroundGraphicType integer constant.
*/
getGraphicType() {
}
/**
* Gets and sets the page background graphic type.
* The value of the property is OdsPageBackgroundGraphicType integer constant.
*/
setGraphicType(value) {
}
/**
* Gets and set the background graphic position.
* The value of the property is OdsPageBackgroundGraphicPositionType integer constant.
*/
getGraphicPositionType() {
}
/**
* Gets and set the background graphic position.
* The value of the property is OdsPageBackgroundGraphicPositionType integer constant.
*/
setGraphicPositionType(value) {
}
/**
* Indicates whether it's a linked graphic.
*/
isLink() {
}
/**
* Gets and sets the linked graphic path.
*/
getLinkedGraphic() {
}
/**
* Gets and sets the linked graphic path.
*/
setLinkedGraphic(value) {
}
/**
* Gets and sets the graphic data.
*/
getGraphicData() {
}
/**
* Gets and sets the graphic data.
*/
setGraphicData(value) {
}
}
/**
* Represents the options of saving ods file.
*/
class OdsSaveOptions {
/**
* Creates the options of saving ods file.
*/
constructor() {
}
/**
* Creates the options of saving ods file.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Gets and sets the generator of the ods file.
* The value of the property is OdsGeneratorType integer constant.
*/
getGeneratorType() {
}
/**
* Gets and sets the generator of the ods file.
* The value of the property is OdsGeneratorType integer constant.
*/
setGeneratorType(value) {
}
/**
* Indicates whether the ods file should be saved as ODF format version 1.1. Default is false.
* 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.
*/
isStrictSchema11() {
}
/**
* Indicates whether the ods file should be saved as ODF format version 1.1. Default is false.
* 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.
*/
setStrictSchema11(value) {
}
/**
* Gets and sets the ODF version.
* The value of the property is OpenDocumentFormatVersionType integer constant.
*/
getOdfStrictVersion() {
}
/**
* Gets and sets the ODF version.
* The value of the property is OpenDocumentFormatVersionType integer constant.
*/
setOdfStrictVersion(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents an OleObject in a worksheet.
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* //Instantiate a new Workbook.
* var workbook = new aspose.cells.Workbook();
* //Get the first worksheet.
* var sheet = workbook.getWorksheets().get(0);
* var imageStream = fs.createReadStream("boxing.PNG");
* var excelStream = fs.createReadStream("Book1.xls");
* //Obtain the picture into the array of bytes from streams.
* aspose.cells.readBytesFromStream(imageStream, function(bytes) {
* //Add an Ole object into the worksheet with the bytes in callback function
* sheet.getOleObjects().add(14, 3, 200, 220, bytes);
* aspose.cells.readBytesFromStream(excelStream, function(bytes) {
* //Set embedded ole object data in callback function
* sheet.getOleObjects().get(0).setObjectData(bytes);
* //Save the excel file
* workbook.save("Book2.xls");
* });
* });
* @hideconstructor
*/
class OleObject {
/**
* True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content
* when the ole object is activated.
*/
isAutoSize() {
}
/**
* True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content
* when the ole object is activated.
*/
setAutoSize(value) {
}
/**
* Returns true if the OleObject links to the file.
*/
isLink() {
}
/**
* Returns true if the OleObject links to the file.
*/
setLink(value) {
}
/**
* True if the specified object is displayed as an icon
* and the image will not be auto changed.
*/
getDisplayAsIcon() {
}
/**
* True if the specified object is displayed as an icon
* and the image will not be auto changed.
*/
setDisplayAsIcon(value) {
}
/**
* Represents image of ole object as byte array.
*/
getImageData() {
}
/**
* Represents image of ole object as byte array.
*/
setImageData(value) {
}
/**
* Represents embedded ole object data as byte array.
*/
getObjectData() {
}
/**
* Represents embedded ole object data as byte array.
*/
setObjectData(value) {
}
/**
* Gets the full embedded ole object binary data in the template file.
*/
getFullObjectBin() {
}
/**
* Gets or sets the path and name of the source file for the linked image.
* The default value is an empty string.
* If SourceFullName is not an empty string, the image is linked.
* If SourceFullName is not an empty string, but Data is null, then the image is linked and not stored in the file.
*/
getImageSourceFullName() {
}
/**
* Gets or sets the path and name of the source file for the linked image.
* The default value is an empty string.
* If SourceFullName is not an empty string, the image is linked.
* If SourceFullName is not an empty string, but Data is null, then the image is linked and not stored in the file.
*/
setImageSourceFullName(value) {
}
/**
* Gets or sets the ProgID of the OLE object.
*/
getProgID() {
}
/**
* Gets or sets the ProgID of the OLE object.
*/
setProgID(value) {
}
/**
* Gets and sets the file type of the embedded ole object data
* The value of the property is FileFormatType integer constant.
*/
getFileFormatType() {
}
/**
* Gets and sets the file type of the embedded ole object data
* The value of the property is FileFormatType integer constant.
*/
setFileFormatType(value) {
}
/**
* Returns the source full name of the source file for the linked OLE object.
* Only supports setting the source full name when the file type is OleFileType.Unknown.
* Such as wav file ,avi file..etc..
*/
getObjectSourceFullName() {
}
/**
* Returns the source full name of the source file for the linked OLE object.
* Only supports setting the source full name when the file type is OleFileType.Unknown.
* Such as wav file ,avi file..etc..
*/
setObjectSourceFullName(value) {
}
/**
* Gets and sets the display label of the linked ole object.
*/
getLabel() {
}
/**
* Gets and sets the display label of the linked ole object.
*/
setLabel(value) {
}
/**
* Returns the source full name of the source file for the linked OLE object.
* NOTE: This member is now obsolete. Instead,
* please use OleObject.ObjectSourceFullName property.
* This property will be removed 12 months later since November 2013.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSourceFullName() {
}
/**
* Returns the source full name of the source file for the linked OLE object.
* NOTE: This member is now obsolete. Instead,
* please use OleObject.ObjectSourceFullName property.
* This property will be removed 12 months later since November 2013.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSourceFullName(value) {
}
/**
* Specifies whether the link to the OleObject is automatically updated or not.
*/
getAutoUpdate() {
}
/**
* Specifies whether the link to the OleObject is automatically updated or not.
*/
setAutoUpdate(value) {
}
/**
* Specifies whether the host application for the embedded object shall be called to load
* the object data automatically when the parent workbook is opened.
*/
getAutoLoad() {
}
/**
* Specifies whether the host application for the embedded object shall be called to load
* the object data automatically when the parent workbook is opened.
*/
setAutoLoad(value) {
}
/**
* Gets and sets the class identifier of the embedded object.
* It means which application opens the embedded file.
*/
getClassIdentifier() {
}
/**
* Gets and sets the class identifier of the embedded object.
* It means which application opens the embedded file.
*/
setClassIdentifier(value) {
}
/**
* Gets the image format of the ole object.
* The value of the property is ImageType integer constant.
*/
getImageType() {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Sets embedded object data.
* @param {boolean} linkToFile - Indicates whether the object links to the file. If true, the parameter objectData is ignored.
* @param {byte[]} objectData - The embedded object data.
* @param {String} sourceFileName - The file name.
* @param {boolean} displayAsIcon - Indicates whether diplaying object as an icon.
* If true, the orginal image data will be covered by icon.
* @param {String} label - The icon label. Only works when displayAsIcon as true.
*/
setEmbeddedObject(linkToFile, objectData, sourceFileName, displayAsIcon, label) {
}
/**
* Sets embedded object data.
* As Aspose can update embedd all file icons, so it's better that you can add correct icon with updateIcon as false.
* @param {boolean} linkToFile - Indicates whether the object links to the file. If true, the parameter objectData is ignored.
* @param {byte[]} objectData - The embedded object data.
* @param {String} sourceFileName - The file name.
* @param {boolean} displayAsIcon - Indicates whether diplaying object as an icon.
* If true, the orginal image data will be covered by icon.
* @param {String} label - The icon label. Only works when displayAsIcon as true.
* @param {boolean} updateIcon - Indicates whether automatically updating icon.
*/
setEmbeddedObject(linkToFile, objectData, sourceFileName, displayAsIcon, label, updateIcon) {
}
/**
* Sets the ole native source full file name with path.
* @param {String} sourceFullName - the ole native source full file name
*/
setNativeSourceFullName(sourceFullName) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents embedded OLE objects.
* @hideconstructor
*/
class OleObjectCollection {
/**
*/
getCount() {
}
/**
* Gets the OleObject element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {OleObject} The element at the specified index.
*/
get(index) {
}
/**
* Adds an OleObject to the collection.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} height - Height of oleObject, in unit of pixel.
* @param {Number} width - Width of oleObject, in unit of pixel.
* @param {byte[]} imageData - Image of ole object as byte array.
* @return {Number} OleObject object index.
*/
add(upperLeftRow, upperLeftColumn, height, width, imageData) {
}
/**
* Adds a linked OleObject to the collection.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} height - Height of oleObject, in unit of pixel.
* @param {Number} width - Width of oleObject, in unit of pixel.
* @param {byte[]} imageData - Image of ole object as byte array.
* @param {String} linkedFile
* @return {Number} OleObject object index.
*/
add(upperLeftRow, upperLeftColumn, height, width, imageData, linkedFile) {
}
/**
* Remove all embedded OLE objects.
*/
clear() {
}
/**
* Removes the element at the specified index.
* @param {Number} index - The specified index.
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the options of saving office open xml file.
*/
class OoxmlSaveOptions {
/**
* Creates the options for saving office open xml file.
*/
constructor() {
}
/**
* Creates the options for saving office open xml file.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file.
* If the output file may be accessed by SQL Server DTS, this value must be true.
* Setting the value to false will highly increase the performance and reduce the file size when creating large file.
* Default value is true.
*/
getExportCellName() {
}
/**
* Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file.
* If the output file may be accessed by SQL Server DTS, this value must be true.
* Setting the value to false will highly increase the performance and reduce the file size when creating large file.
* Default value is true.
*/
setExportCellName(value) {
}
/**
* The data provider for saving workbook in light mode.
*/
getLightCellsDataProvider() {
}
/**
* The data provider for saving workbook in light mode.
*/
setLightCellsDataProvider(value) {
}
/**
* Indicates whether update scaling factor before saving the file
* if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
* The default value is false for performance.
*/
getUpdateZoom() {
}
/**
* Indicates whether update scaling factor before saving the file
* if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
* The default value is false for performance.
*/
setUpdateZoom(value) {
}
/**
* Always use ZIP64 extensions when writing zip archives, even when unnecessary.
*/
getEnableZip64() {
}
/**
* Always use ZIP64 extensions when writing zip archives, even when unnecessary.
*/
setEnableZip64(value) {
}
/**
* Indicates whether embedding Ooxml files of OleObject as ole object.
* Only for OleObject.
*/
getEmbedOoxmlAsOleObject() {
}
/**
* Indicates whether embedding Ooxml files of OleObject as ole object.
* Only for OleObject.
*/
setEmbedOoxmlAsOleObject(value) {
}
/**
* Gets and sets the compression type for ooxml file.
* The value of the property is OoxmlCompressionType integer constant.The default value is OoxmlCompressionType.Level2.
*/
getCompressionType() {
}
/**
* Gets and sets the compression type for ooxml file.
* The value of the property is OoxmlCompressionType integer constant.The default value is OoxmlCompressionType.Level2.
*/
setCompressionType(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents an outline on a worksheet.
* @hideconstructor
*/
class Outline {
/**
* Indicates if the summary row will be positioned below the detail rows in the outline.
*/
getSummaryRowBelow() {
}
/**
* Indicates if the summary row will be positioned below the detail rows in the outline.
*/
setSummaryRowBelow(value) {
}
/**
* Indicates if the summary column will be positioned to the right of the detail columns in the outline.
*/
getSummaryColumnRight() {
}
/**
* Indicates if the summary column will be positioned to the right of the detail columns in the outline.
*/
setSummaryColumnRight(value) {
}
}
/**
* Represents the oval shape.
* @hideconstructor
*/
class Oval {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Info for a page ends saving process.
* @hideconstructor
*/
class PageEndSavingArgs {
/**
* Gets or sets a value indicating whether having more pages to be output.
* The default value is true.
*/
hasMorePages() {
}
/**
* Gets or sets a value indicating whether having more pages to be output.
* The default value is true.
*/
setHasMorePages(value) {
}
/**
* Current page index, zero based.
*/
getPageIndex() {
}
/**
* Total page count.
*/
getPageCount() {
}
}
/**
* Info for a page saving process.
* @hideconstructor
*/
class PageSavingArgs {
/**
* Current page index, zero based.
*/
getPageIndex() {
}
/**
* Total page count.
*/
getPageCount() {
}
}
/**
* Encapsulates the object that represents the page setup description.
* The PageSetup object contains all page setup options.
* @example
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* sheet.getPageSetup().setPrintArea("D1:K13");
* sheet.getPageSetup().setPrintTitleRows("$5:$7");
* sheet.getPageSetup().setPrintTitleColumns("$A:$B");
* @hideconstructor
*/
class PageSetup {
/**
* Gets the background of ODS.
*/
getODSPageBackground() {
}
/**
* Represents the range to be printed.
*/
getPrintArea() {
}
/**
* Represents the range to be printed.
*/
setPrintArea(value) {
}
/**
* Represents the columns that contain the cells to be repeated on the left side of each page.
*/
getPrintTitleColumns() {
}
/**
* Represents the columns that contain the cells to be repeated on the left side of each page.
*/
setPrintTitleColumns(value) {
}
/**
* Represents the rows that contain the cells to be repeated at the top of each page.
*/
getPrintTitleRows() {
}
/**
* Represents the rows that contain the cells to be repeated at the top of each page.
*/
setPrintTitleRows(value) {
}
/**
* Represents if elements of the document will be printed in black and white.
*/
getBlackAndWhite() {
}
/**
* Represents if elements of the document will be printed in black and white.
*/
setBlackAndWhite(value) {
}
/**
* Represent if the sheet is printed centered horizontally.
*/
getCenterHorizontally() {
}
/**
* Represent if the sheet is printed centered horizontally.
*/
setCenterHorizontally(value) {
}
/**
* Represent if the sheet is printed centered vertically.
*/
getCenterVertically() {
}
/**
* Represent if the sheet is printed centered vertically.
*/
setCenterVertically(value) {
}
/**
* Represents if the sheet will be printed without graphics.
*/
getPrintDraft() {
}
/**
* Represents if the sheet will be printed without graphics.
*/
setPrintDraft(value) {
}
/**
* Represents the distance from the bottom of the page to the footer, in unit of centimeters.
*/
getFooterMargin() {
}
/**
* Represents the distance from the bottom of the page to the footer, in unit of centimeters.
*/
setFooterMargin(value) {
}
/**
* Represents the distance from the bottom of the page to the footer, in unit of inches.
*/
getFooterMarginInch() {
}
/**
* Represents the distance from the bottom of the page to the footer, in unit of inches.
*/
setFooterMarginInch(value) {
}
/**
* Represents the distance from the top of the page to the header, in unit of centimeters.
*/
getHeaderMargin() {
}
/**
* Represents the distance from the top of the page to the header, in unit of centimeters.
*/
setHeaderMargin(value) {
}
/**
* Represents the distance from the top of the page to the header, in unit of inches.
*/
getHeaderMarginInch() {
}
/**
* Represents the distance from the top of the page to the header, in unit of inches.
*/
setHeaderMarginInch(value) {
}
/**
* Gets and sets the settings of the default printer.
*/
getPrinterSettings() {
}
/**
* Gets and sets the settings of the default printer.
*/
setPrinterSettings(value) {
}
/**
* Represents the size of the left margin, in unit of centimeters.
*/
getLeftMargin() {
}
/**
* Represents the size of the left margin, in unit of centimeters.
*/
setLeftMargin(value) {
}
/**
* Represents the size of the left margin, in unit of inches.
*/
getLeftMarginInch() {
}
/**
* Represents the size of the left margin, in unit of inches.
*/
setLeftMarginInch(value) {
}
/**
* Represents the size of the right margin, in unit of centimeters.
*/
getRightMargin() {
}
/**
* Represents the size of the right margin, in unit of centimeters.
*/
setRightMargin(value) {
}
/**
* Represents the size of the right margin, in unit of inches.
*/
getRightMarginInch() {
}
/**
* Represents the size of the right margin, in unit of inches.
*/
setRightMarginInch(value) {
}
/**
* Represents the size of the top margin, in unit of centimeters.
*/
getTopMargin() {
}
/**
* Represents the size of the top margin, in unit of centimeters.
*/
setTopMargin(value) {
}
/**
* Represents the size of the top margin, in unit of inches.
*/
getTopMarginInch() {
}
/**
* Represents the size of the top margin, in unit of inches.
*/
setTopMarginInch(value) {
}
/**
* Represents the size of the bottom margin, in unit of centimeters.
*/
getBottomMargin() {
}
/**
* Represents the size of the bottom margin, in unit of centimeters.
*/
setBottomMargin(value) {
}
/**
* Represents the size of the bottom margin, in unit of inches.
*/
getBottomMarginInch() {
}
/**
* Represents the size of the bottom margin, in unit of inches.
*/
setBottomMarginInch(value) {
}
/**
* Represents the first page number that will be used when this sheet is printed.
*/
getFirstPageNumber() {
}
/**
* Represents the first page number that will be used when this sheet is printed.
*/
setFirstPageNumber(value) {
}
/**
* Represents the number of pages tall the worksheet will be scaled to when it's printed.
* The default value is 1.
* You have to set FitToPagesWide as zero if you want to fit all rows on one page.
*/
getFitToPagesTall() {
}
/**
* Represents the number of pages tall the worksheet will be scaled to when it's printed.
* The default value is 1.
* You have to set FitToPagesWide as zero if you want to fit all rows on one page.
*/
setFitToPagesTall(value) {
}
/**
* Represents the number of pages wide the worksheet will be scaled to when it's printed.
* The default value is 1.
* You have to set FitToPagesTall as zero if you want to fit all columns on one page.
*/
getFitToPagesWide() {
}
/**
* Represents the number of pages wide the worksheet will be scaled to when it's printed.
* The default value is 1.
* You have to set FitToPagesTall as zero if you want to fit all columns on one page.
*/
setFitToPagesWide(value) {
}
/**
* If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled.
*/
isPercentScale() {
}
/**
* If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled.
*/
setPercentScale(value) {
}
/**
* Represents the order that Microsoft Excel uses to number pages when printing a large worksheet.
* The value of the property is PrintOrderType integer constant.
*/
getOrder() {
}
/**
* Represents the order that Microsoft Excel uses to number pages when printing a large worksheet.
* The value of the property is PrintOrderType integer constant.
*/
setOrder(value) {
}
/**
* Indicates whether the paper size is automatic.
*/
isAutomaticPaperSize() {
}
/**
* Represents the size of the paper.
* The value of the property is PaperSizeType integer constant.
*/
getPaperSize() {
}
/**
* Represents the size of the paper.
* The value of the property is PaperSizeType integer constant.
*/
setPaperSize(value) {
}
/**
* Gets the width of the paper in unit of inches, considered page orientation.
*/
getPaperWidth() {
}
/**
* Gets the height of the paper in unit of inches , considered page orientation.
*/
getPaperHeight() {
}
/**
* Represents page print orientation.
* The value of the property is PageOrientationType integer constant.
*/
getOrientation() {
}
/**
* Represents page print orientation.
* The value of the property is PageOrientationType integer constant.
*/
setOrientation(value) {
}
/**
* Represents the way comments are printed with the sheet.
* The value of the property is PrintCommentsType integer constant.
*/
getPrintComments() {
}
/**
* Represents the way comments are printed with the sheet.
* The value of the property is PrintCommentsType integer constant.
*/
setPrintComments(value) {
}
/**
* Specifies the type of print error displayed.
* The value of the property is PrintErrorsType integer constant.
*/
getPrintErrors() {
}
/**
* Specifies the type of print error displayed.
* The value of the property is PrintErrorsType integer constant.
*/
setPrintErrors(value) {
}
/**
* Represents if row and column headings are printed with this page.
*/
getPrintHeadings() {
}
/**
* Represents if row and column headings are printed with this page.
*/
setPrintHeadings(value) {
}
/**
* Represents if cell gridlines are printed on the page.
*/
getPrintGridlines() {
}
/**
* Represents if cell gridlines are printed on the page.
*/
setPrintGridlines(value) {
}
/**
* Represents the scaling factor in percent. It should be between 10 and 400.
*/
getZoom() {
}
/**
* Represents the scaling factor in percent. It should be between 10 and 400.
*/
setZoom(value) {
}
/**
* Indicates whether the first the page number is automatically assigned.
*/
isAutoFirstPageNumber() {
}
/**
* Indicates whether the first the page number is automatically assigned.
*/
setAutoFirstPageNumber(value) {
}
/**
* Represents the print quality.
*/
getPrintQuality() {
}
/**
* Represents the print quality.
*/
setPrintQuality(value) {
}
/**
* Get and sets number of copies to print.
*/
getPrintCopies() {
}
/**
* Get and sets number of copies to print.
*/
setPrintCopies(value) {
}
/**
* True means that the header/footer of the odd pages is different with odd pages.
*/
isHFDiffOddEven() {
}
/**
* True means that the header/footer of the odd pages is different with odd pages.
*/
setHFDiffOddEven(value) {
}
/**
* True means that the header/footer of the first page is different with other pages.
*/
isHFDiffFirst() {
}
/**
* True means that the header/footer of the first page is different with other pages.
*/
setHFDiffFirst(value) {
}
/**
* Indicates whether header and footer are scaled with document scaling.
* Only applies for Excel 2007.
*/
isHFScaleWithDoc() {
}
/**
* Indicates whether header and footer are scaled with document scaling.
* Only applies for Excel 2007.
*/
setHFScaleWithDoc(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setHFAlignMargins(value) {
}
/**
* Sets an image in the header of a worksheet.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {byte[]} headerPicture - Image data.
* @return {Picture} Returns Picture object.
*/
setHeaderPicture(section, headerPicture) {
}
/**
* Sets an image in the footer of a worksheet.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {byte[]} footerPicture - Image data.
* @return {Picture} Returns Picture object.
*/
setFooterPicture(section, footerPicture) {
}
/**
* Sets an image in the header/footer of a worksheet.
* @param {boolean} isFirst - Indicates whether setting the picture of first page header/footer.
* @param {boolean} isEven - Indicates whether setting the picture of even page header/footer.
* @param {boolean} isHeader - Indicates whether setting the picture of header/footer.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {byte[]} imageData - Image data.
* @return {Picture} Returns Picture object.
*/
setPicture(isFirst, isEven, isHeader, section, imageData) {
}
/**
* Gets the Picture object of the header / footer.
* @param {boolean} isHeader - Indicates whether it is in the header or footer.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @return {Picture} Returns Picture object.
* Returns null if there is no picture.
*/
getPicture(isHeader, section) {
}
/**
* Gets the Picture object of the header / footer.
* @param {boolean} isFirst - Indicates whether getting the picture of first page header/footer.
* @param {boolean} isEven - Indicates whether getting the picture of even page header/footer.
* @param {boolean} isHeader - Indicates whether getting the picture of header/footer.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @return {Picture} Returns Picture object.
*/
getPicture(isFirst, isEven, isHeader, section) {
}
/**
* Copies the setting of the page setup.
* @param {PageSetup} source - The source.
* @param {CopyOptions} copyOptions - The copy options.
*/
copy(source, copyOptions) {
}
/**
* Sets the number of pages the worksheet will be scaled to when it's printed.
* @param {Number} wide - Pages wide.
* @param {Number} tall - Pages tall.
*/
setFitToPages(wide, tall) {
}
/**
* Sets the custom paper size, in unit of inches.
* @param {Number} width - The width of the paper.
* @param {Number} height - The height of the paper.
*/
customPaperSize(width, height) {
}
/**
* Clears header and footer setting.
*/
clearHeaderFooter() {
}
/**
* Gets a script formatting the header of an Excel file.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
*/
getHeader(section) {
}
/**
* Gets all commands of header or footer.
* @param {String} headerFooterScript - The header/footer script
* @return {HeaderFooterCommand[]} Returns all commands of header or footer.
*/
getCommands(headerFooterScript) {
}
/**
* Gets a script formatting the footer of an Excel file.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
*/
getFooter(section) {
}
/**
* Sets a script formatting the header of an Excel file.
* Script commands:CommandDescription&PCurrent page number &NPage count &DCurrent date &TCurrent time&ASheet name&FFile 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&GImage script
* For example: "&Arial,Bold&8Header Note"
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {String} headerScript - Header format script.
*/
setHeader(section, headerScript) {
}
/**
* Sets a script formatting the footer of an Excel file.
* Script commands:CommandDescription&PCurrent page number &NPage count &DCurrent date &TCurrent time&ASheet name&FFile 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&GImage script
* For example: "&Arial,Bold&8Footer Note"
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {String} footerScript - Footer format script.
*/
setFooter(section, footerScript) {
}
/**
* Sets a script formatting the even page header of an Excel file.
* Only effect in Excel 2007 when IsHFDiffOddEven is true.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {String} headerScript - Header format script.
*/
setEvenHeader(section, headerScript) {
}
/**
* Gets a script formatting the even header of an Excel file.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
*/
getEvenHeader(section) {
}
/**
* Sets a script formatting the even page footer of an Excel file.
* Only effect in Excel 2007 when IsHFDiffOddEven is true.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {String} footerScript - Footer format script.
*/
setEvenFooter(section, footerScript) {
}
/**
* Gets a script formatting the even footer of an Excel file.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
*/
getEvenFooter(section) {
}
/**
* Sets a script formatting the first page header of an Excel file.
* Only effect in Excel 2007 when IsHFDiffFirst is true.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {String} headerScript - Header format script.
*/
setFirstPageHeader(section, headerScript) {
}
/**
* Gets a script formatting the first page header of an Excel file.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
*/
getFirstPageHeader(section) {
}
/**
* Sets a script formatting the first page footer of an Excel file.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
* @param {String} footerScript - Footer format script.
*/
setFirstPageFooter(section, footerScript) {
}
/**
* Gets a script formatting the first page footer of an Excel file.
* @param {Number} section - 0: Left Section, 1: Center Section, 2: Right Section.
*/
getFirstPageFooter(section) {
}
}
/**
* Info for a page starts saving process.
* @hideconstructor
*/
class PageStartSavingArgs {
/**
* Gets or sets a value indicating whether the page should be output.
* The default value is true.
*/
isToOutput() {
}
/**
* Gets or sets a value indicating whether the page should be output.
* The default value is true.
*/
setToOutput(value) {
}
/**
* Current page index, zero based.
*/
getPageIndex() {
}
/**
* Total page count.
*/
getPageCount() {
}
}
/**
* Represents the options for pagination.
* @hideconstructor
*/
class PaginatedSaveOptions {
/**
* 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() {
}
/**
* 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.
*/
setDefaultFont(value) {
}
/**
* 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.
* Default is true.
*/
getCheckWorkbookDefaultFont() {
}
/**
* 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.
* Default is true.
*/
setCheckWorkbookDefaultFont(value) {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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() {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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) {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
isFontSubstitutionCharGranularity() {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
setFontSubstitutionCharGranularity(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOnePagePerSheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAllColumnsInOnePagePerSheet(value) {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
getIgnoreError() {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
setIgnoreError(value) {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
getOutputBlankPageWhenNothingToPrint() {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
setOutputBlankPageWhenNothingToPrint(value) {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
getPageIndex() {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
setPageIndex(value) {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
getPageCount() {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
setPageCount(value) {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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() {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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) {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
getGridlineType() {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
setGridlineType(value) {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
getTextCrossType() {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
setTextCrossType(value) {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
getDefaultEditLanguage() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
setDefaultEditLanguage(value) {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
getSheetSet() {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
setSheetSet(value) {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
getDrawObjectEventHandler() {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
setDrawObjectEventHandler(value) {
}
/**
* Control/Indicate progress of page saving process.
*/
getPageSavingCallback() {
}
/**
* Control/Indicate progress of page saving process.
*/
setPageSavingCallback(value) {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
getEmfRenderSetting() {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
setEmfRenderSetting(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents all Pane objects shown in the specified window.
* @hideconstructor
*/
class PaneCollection {
/**
* Gets and sets the first visible row of the bottom pane.
*/
getFirstVisibleRowOfBottomPane() {
}
/**
* Gets and sets the first visible row of the bottom pane.
*/
setFirstVisibleRowOfBottomPane(value) {
}
/**
* Gets and sets the first visible column of the right pane.
*/
getFirstVisibleColumnOfRightPane() {
}
/**
* Gets and sets the first visible column of the right pane.
*/
setFirstVisibleColumnOfRightPane(value) {
}
/**
* Gets and sets the active pane.
* The value of the property is RectangleAlignmentType integer constant.
*/
getAcitvePaneType() {
}
/**
* Gets and sets the active pane.
* The value of the property is RectangleAlignmentType integer constant.
*/
setAcitvePaneType(value) {
}
}
/**
* Represents the paste special options.
*/
class PasteOptions {
/**
*/
constructor() {
}
/**
* The paste special type.
* The value of the property is PasteType integer constant.
*/
getPasteType() {
}
/**
* The paste special type.
* The value of the property is PasteType integer constant.
*/
setPasteType(value) {
}
/**
* Indicates whether skips blank cells.
*/
getSkipBlanks() {
}
/**
* Indicates whether skips blank cells.
*/
setSkipBlanks(value) {
}
/**
* True means only copying visible cells.
*/
getOnlyVisibleCells() {
}
/**
* True means only copying visible cells.
*/
setOnlyVisibleCells(value) {
}
/**
* True to transpose rows and columns when the range is pasted. The default value is False.
*/
getTranspose() {
}
/**
* True to transpose rows and columns when the range is pasted. The default value is False.
*/
setTranspose(value) {
}
/**
* Gets and sets the operation type when pasting range.
* The value of the property is PasteOperationType integer constant.
*/
getOperationType() {
}
/**
* Gets and sets the operation type when pasting range.
* The value of the property is PasteOperationType integer constant.
*/
setOperationType(value) {
}
/**
* Ingore links to the original file.
*/
getIgnoreLinksToOriginalFile() {
}
/**
* Ingore links to the original file.
*/
setIgnoreLinksToOriginalFile(value) {
}
}
/**
* Encapsulates the object that represents pattern fill format
* @hideconstructor
*/
class PatternFill {
/**
* Gets or sets the fill pattern type
* The value of the property is FillPattern integer constant.
*/
getPattern() {
}
/**
* Gets or sets the fill pattern type
* The value of the property is FillPattern integer constant.
*/
setPattern(value) {
}
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
getBackgroundColor() {
}
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
setBackgroundColor(value) {
}
/**
* Gets and sets the foreground CellsColor object.
*/
getBackgroundCellsColor() {
}
/**
* Gets and sets the foreground CellsColor object.
*/
setBackgroundCellsColor(value) {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
getForegroundColor() {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
setForegroundColor(value) {
}
/**
* Gets and sets the foreground CellsColor object.
*/
getForegroundCellsColor() {
}
/**
* Gets and sets the foreground CellsColor object.
*/
setForegroundCellsColor(value) {
}
/**
* Gets or sets the transparency of foreground color.
*/
getForeTransparency() {
}
/**
* Gets or sets the transparency of foreground color.
*/
setForeTransparency(value) {
}
/**
* Gets or sets the transparency of background color.
*/
getBackTransparency() {
}
/**
* Gets or sets the transparency of background color.
*/
setBackTransparency(value) {
}
/**
* /
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* 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.
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var java = require("java");
* var workbook = new aspose.cells.Workbook();
* workbook.getWorksheets().add();
* workbook.getWorksheets().add();
* var cellInPage1 = workbook.getWorksheets().get(0).getCells().get("A1");
* var cellInPage2 = workbook.getWorksheets().get(1).getCells().get("A1");
* var cellInPage3 = workbook.getWorksheets().get(2).getCells().get("A1");
* cellInPage1.putValue("page1");
* cellInPage2.putValue("page2");
* cellInPage3.putValue("page3");
* var pbeRoot = new aspose.cells.PdfBookmarkEntry();
* pbeRoot.setText("root");
* pbeRoot.setDestination(cellInPage1);
* var list = java.newInstanceSync("java.util.ArrayList");
* pbeRoot.setSubEntry(list);
* pbeRoot.setOpen(false);
* var subPbe1 = new aspose.cells.PdfBookmarkEntry();
* subPbe1.setText("section1");
* subPbe1.setDestination(cellInPage2);
* var subPbe2 = new aspose.cells.PdfBookmarkEntry();
* subPbe2.setText("section2");
* subPbe2.setDestination(cellInPage3);
* pbeRoot.getSubEntry().add(subPbe1);
* pbeRoot.getSubEntry().add(subPbe2);
* var opts = new aspose.cells.PdfSaveOptions();
* opts.setBookmark(pbeRoot);
* workbook.save("Test.pdf", opts);
*/
class PdfBookmarkEntry {
/**
*/
constructor() {
}
/**
* Title of a bookmark.
*/
getText() {
}
/**
* Title of a bookmark.
*/
setText(value) {
}
/**
* The cell to which the bookmark link.
*/
getDestination() {
}
/**
* The cell to which the bookmark link.
*/
setDestination(value) {
}
/**
* Gets or sets name of destination.
* If destination name is set, the destination will be defined as a named destination with this name.
*/
getDestinationName() {
}
/**
* Gets or sets name of destination.
* If destination name is set, the destination will be defined as a named destination with this name.
*/
setDestinationName(value) {
}
/**
* SubEntry of a bookmark.
*/
getSubEntry() {
}
/**
* SubEntry of a bookmark.
*/
setSubEntry(value) {
}
/**
* When this property is true, the bookmarkentry will expand, otherwise it will collapse.
*/
isOpen() {
}
/**
* When this property is true, the bookmarkentry will expand, otherwise it will collapse.
*/
setOpen(value) {
}
/**
* When this property is true, the bookmarkentry will collapse, otherwise it will expand.
*/
isCollapse() {
}
/**
* When this property is true, the bookmarkentry will collapse, otherwise it will expand.
*/
setCollapse(value) {
}
}
/**
* Represents the options for saving pdf file.
*/
class PdfSaveOptions {
/**
* Creates the options for saving pdf file.
*/
constructor() {
}
/**
* 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() {
}
/**
* 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.
*/
setEmbedStandardWindowsFonts(value) {
}
/**
* Gets and sets the PdfBookmarkEntry object.
*/
getBookmark() {
}
/**
* Gets and sets the PdfBookmarkEntry object.
*/
setBookmark(value) {
}
/**
* Gets or sets the PDF standards compliance level for output documents.
* The value of the property is PdfCompliance integer constant.
* Default is Pdf17.
*/
getCompliance() {
}
/**
* Gets or sets the PDF standards compliance level for output documents.
* The value of the property is PdfCompliance integer constant.
* Default is Pdf17.
*/
setCompliance(value) {
}
/**
* Set this options, when security is need in xls2pdf result.
*/
getSecurityOptions() {
}
/**
* Set this options, when security is need in xls2pdf result.
*/
setSecurityOptions(value) {
}
/**
* Represents the image type when converting the chart and shape .
* NOTE: This member is now obsolete. Instead,
* Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getImageType() {
}
/**
* Represents the image type when converting the chart and shape .
* NOTE: This member is now obsolete. Instead,
* Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setImageType(value) {
}
/**
* Indicates whether to calculate formulas before saving pdf file.
* The default value is false.
*/
getCalculateFormula() {
}
/**
* Indicates whether to calculate formulas before saving pdf file.
* The default value is false.
*/
setCalculateFormula(value) {
}
/**
* Indicate the compression algorithm
* The value of the property is PdfCompressionCore integer constant.
*/
getPdfCompression() {
}
/**
* Indicate the compression algorithm
* The value of the property is PdfCompressionCore integer constant.
*/
setPdfCompression(value) {
}
/**
* Gets and sets the time of generating the pdf document.
* if it is not be set, it will be the time of generating the pdf.
*/
getCreatedTime() {
}
/**
* Gets and sets the time of generating the pdf document.
* if it is not be set, it will be the time of generating the pdf.
*/
setCreatedTime(value) {
}
/**
* Gets and sets producer of generated pdf document.
* If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used.
*/
getProducer() {
}
/**
* Gets and sets producer of generated pdf document.
* If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used.
*/
setProducer(value) {
}
/**
* Gets and sets pdf optimization type.
* The value of the property is PdfOptimizationType integer constant.
* Default value is PdfOptimizationType.STANDARD
*/
getOptimizationType() {
}
/**
* Gets and sets pdf optimization type.
* The value of the property is PdfOptimizationType integer constant.
* Default value is PdfOptimizationType.STANDARD
*/
setOptimizationType(value) {
}
/**
* Gets or sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None.
* The value of the property is PdfCustomPropertiesExport integer constant.
*/
getCustomPropertiesExport() {
}
/**
* Gets or sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None.
* The value of the property is PdfCustomPropertiesExport integer constant.
*/
setCustomPropertiesExport(value) {
}
/**
* Indicates whether to export document structure.
*/
getExportDocumentStructure() {
}
/**
* Indicates whether to export document structure.
*/
setExportDocumentStructure(value) {
}
/**
* Indicates whether the window's title bar should display the document title.
* If false, the title bar should instead display the name of the PDF file.
* Default value is false.
*/
getDisplayDocTitle() {
}
/**
* Indicates whether the window's title bar should display the document title.
* If false, the title bar should instead display the name of the PDF file.
* Default value is false.
*/
setDisplayDocTitle(value) {
}
/**
* Gets or sets embedded font encoding in pdf.
* The value of the property is PdfFontEncoding integer constant.
* Default value is PdfFontEncoding.IDENTITY
*/
getFontEncoding() {
}
/**
* Gets or sets embedded font encoding in pdf.
* The value of the property is PdfFontEncoding integer constant.
* Default value is PdfFontEncoding.IDENTITY
*/
setFontEncoding(value) {
}
/**
* Gets or sets watermark to output.
*/
getWatermark() {
}
/**
* Gets or sets watermark to output.
*/
setWatermark(value) {
}
/**
* Indicates whether to embed attchment for Ole objects in Excel.
* Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled.
*/
getEmbedAttachments() {
}
/**
* Indicates whether to embed attchment for Ole objects in Excel.
* Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled.
*/
setEmbedAttachments(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDefaultFont(value) {
}
/**
* 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.
* Default is true.
*/
getCheckWorkbookDefaultFont() {
}
/**
* 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.
* Default is true.
*/
setCheckWorkbookDefaultFont(value) {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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() {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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) {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
isFontSubstitutionCharGranularity() {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
setFontSubstitutionCharGranularity(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOnePagePerSheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAllColumnsInOnePagePerSheet(value) {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
getIgnoreError() {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
setIgnoreError(value) {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
getOutputBlankPageWhenNothingToPrint() {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
setOutputBlankPageWhenNothingToPrint(value) {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
getPageIndex() {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
setPageIndex(value) {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
getPageCount() {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
setPageCount(value) {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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() {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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) {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
getGridlineType() {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
setGridlineType(value) {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
getTextCrossType() {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
setTextCrossType(value) {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
getDefaultEditLanguage() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
setDefaultEditLanguage(value) {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
getSheetSet() {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
setSheetSet(value) {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
getDrawObjectEventHandler() {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
setDrawObjectEventHandler(value) {
}
/**
* Control/Indicate progress of page saving process.
*/
getPageSavingCallback() {
}
/**
* Control/Indicate progress of page saving process.
*/
setPageSavingCallback(value) {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
getEmfRenderSetting() {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
setEmfRenderSetting(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
/**
* 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 {Number} desiredPPI - Desired pixels per inch. 220 high quality. 150 screen quality. 96 email quality.
* @param {Number} jpegQuality - 0 - 100% JPEG quality.
*/
setImageResample(desiredPPI, jpegQuality) {
}
}
/**
* Options for encrypting and access permissions for a PDF document.
* PDF/A does not allow security setting.
*/
class PdfSecurityOptions {
/**
* The constructor of PdfSecurityOptions
*/
constructor() {
}
/**
* Gets or sets the user password required for opening the encrypted PDF document.
* 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() {
}
/**
* Gets or sets the user password required for opening the encrypted PDF document.
* 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) {
}
/**
* Gets or sets the owner password for the encrypted PDF document.
* The owner password allows the user to open an encrypted PDF document without any access restrictions specified.
*/
getOwnerPassword() {
}
/**
* Gets or sets the owner password for the encrypted PDF document.
* The owner password allows the user to open an encrypted PDF document without any access restrictions specified.
*/
setOwnerPassword(value) {
}
/**
* Indicates whether to allow to print the document.
* Possibly not at the highest quality level,
* depending on whether FullQualityPrintPermission is also set.
*/
getPrintPermission() {
}
/**
* Indicates whether to allow to print the document.
* Possibly not at the highest quality level,
* depending on whether FullQualityPrintPermission is also set.
*/
setPrintPermission(value) {
}
/**
* Indicates whether to allow to modify the contents of the document by operations other than those controlled
* by AnnotationsPermission, FillFormsPermission and AssembleDocumentPermission.
*/
getModifyDocumentPermission() {
}
/**
* Indicates whether to allow to modify the contents of the document by operations other than those controlled
* by AnnotationsPermission, FillFormsPermission and AssembleDocumentPermission.
*/
setModifyDocumentPermission(value) {
}
/**
* Permission to copy or extract content Obsoleted according to PDF reference.
* NOTE: This member is now obsolete. Instead,
* please use ExtractContentPermission property.
* This property will be removed 12 months later since September 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getExtractContentPermissionObsolete() {
}
/**
* Permission to copy or extract content Obsoleted according to PDF reference.
* NOTE: This member is now obsolete. Instead,
* please use ExtractContentPermission property.
* This property will be removed 12 months later since September 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setExtractContentPermissionObsolete(value) {
}
/**
* Indicates whether to allow to add or modify text annotations, fill in interactive form fields.
* if ModifyDocumentPermission is also set, create or modify interactive form fields (including signature fields).
*/
getAnnotationsPermission() {
}
/**
* Indicates whether to allow to add or modify text annotations, fill in interactive form fields.
* if ModifyDocumentPermission is also set, create or modify interactive form fields (including signature fields).
*/
setAnnotationsPermission(value) {
}
/**
* Indicates whether to allow to fill in existing interactive form fields (including signature fields),
* even if ModifyDocumentPermission is clear.
*/
getFillFormsPermission() {
}
/**
* Indicates whether to allow to fill in existing interactive form fields (including signature fields),
* even if ModifyDocumentPermission is clear.
*/
setFillFormsPermission(value) {
}
/**
* Indicates whether to allow to copy or otherwise extract text and graphics from the document
* by operations other than that controlled by AccessibilityExtractContent.
*/
getExtractContentPermission() {
}
/**
* Indicates whether to allow to copy or otherwise extract text and graphics from the document
* by operations other than that controlled by AccessibilityExtractContent.
*/
setExtractContentPermission(value) {
}
/**
* Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes).
*/
getAccessibilityExtractContent() {
}
/**
* Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes).
*/
setAccessibilityExtractContent(value) {
}
/**
* Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images),
* even if ModifyDocumentPermission is clear.
*/
getAssembleDocumentPermission() {
}
/**
* Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images),
* even if ModifyDocumentPermission is clear.
*/
setAssembleDocumentPermission(value) {
}
/**
* Indicates whether to allow to print the document to a representation from
* which a faithful digital copy of the PDF content could be generated.
* When it is clear (and PrintPermission is set), printing is limited to a low level
* representation of the appearance, possibly of degraded quality.
*/
getFullQualityPrintPermission() {
}
/**
* Indicates whether to allow to print the document to a representation from
* which a faithful digital copy of the PDF content could be generated.
* When it is clear (and PrintPermission is set), printing is limited to a low level
* representation of the appearance, possibly of degraded quality.
*/
setFullQualityPrintPermission(value) {
}
}
/**
* Represents picture format option
*/
class PicFormatOption {
/**
*/
constructor() {
}
/**
* Gets or sets the picture fill type.
* The value of the property is FillPictureType integer constant.
*/
getType() {
}
/**
* Gets or sets the picture fill type.
* The value of the property is FillPictureType integer constant.
*/
setType(value) {
}
/**
* Gets or sets how many the picture stack and scale with.
*/
getScale() {
}
/**
* Gets or sets how many the picture stack and scale with.
*/
setScale(value) {
}
/**
* Gets or sets the left offset for stretching picture.
*/
getLeft() {
}
/**
* Gets or sets the left offset for stretching picture.
*/
setLeft(value) {
}
/**
* Gets or sets the top offset for stretching picture.
*/
getTop() {
}
/**
* Gets or sets the top offset for stretching picture.
*/
setTop(value) {
}
/**
* Gets or sets the bottom offset for stretching picture.
*/
getBottom() {
}
/**
* Gets or sets the bottom offset for stretching picture.
*/
setBottom(value) {
}
/**
* Gets or sets the right offset for stretching picture.
*/
getRight() {
}
/**
* Gets or sets the right offset for stretching picture.
*/
setRight(value) {
}
}
/**
* Encapsulates the object that represents a single picture in a spreadsheet.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a picture at the location of a cell whose row and column indices
* //are 5 in the worksheet. It is "F6" cell
* worksheet.getPictures().add(5, 5, "C:\\image.gif");
* //Saving the Excel file
* workbook.save("C:\\Book1.xls", aspose.cells.SaveFormat.EXCEL_97_TO_2003);
* @hideconstructor
*/
class Picture {
/**
* Gets the original height of the picture.
*/
getOriginalHeight() {
}
/**
* Gets the original width of the picture.
*/
getOriginalWidth() {
}
/**
* Represents the com.aspose.cells.Color of the border line of a picture.
*/
getBorderLineColor() {
}
/**
* Represents the com.aspose.cells.Color of the border line of a picture.
*/
setBorderLineColor(value) {
}
/**
* Gets or sets the weight of the border line of a picture in units of pt.
*/
getBorderWeight() {
}
/**
* Gets or sets the weight of the border line of a picture in units of pt.
*/
setBorderWeight(value) {
}
/**
* Gets the data of the picture.
*/
getData() {
}
/**
* Gets the data of the picture.
*/
setData(value) {
}
/**
* Gets or sets the path and name of the source file for the linked image.
* The default value is an empty string.
* If SourceFullName is not an empty string, the image is linked.
* If SourceFullName is not an empty string, but Data is null, then the image is linked and not stored in the file.
*/
getSourceFullName() {
}
/**
* Gets or sets the path and name of the source file for the linked image.
* The default value is an empty string.
* If SourceFullName is not an empty string, the image is linked.
* If SourceFullName is not an empty string, but Data is null, then the image is linked and not stored in the file.
*/
setSourceFullName(value) {
}
/**
* Gets and sets the data of the formula.
*/
getFormula() {
}
/**
* Gets and sets the data of the formula.
*/
setFormula(value) {
}
/**
* True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content
* when the ole object is activated.
*/
isAutoSize() {
}
/**
* True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content
* when the ole object is activated.
*/
setAutoSize(value) {
}
/**
* Returns true if the picture is linked to a file.
*/
isLink() {
}
/**
* Returns true if the picture is linked to a file.
*/
setLink(value) {
}
/**
* Gets or sets whether dynamic data exchange
*/
isDynamicDataExchange() {
}
/**
* Gets or sets whether dynamic data exchange
*/
setDynamicDataExchange(value) {
}
/**
* True if the specified object is displayed as an icon
* and the image will not be auto changed.
*/
getDisplayAsIcon() {
}
/**
* True if the specified object is displayed as an icon
* and the image will not be auto changed.
*/
setDisplayAsIcon(value) {
}
/**
* Gets the image format of the picture.
* The value of the property is ImageType integer constant.
*/
getImageType() {
}
/**
* Gets the original height of picture, in unit of centimeters.
*/
getOriginalHeightCM() {
}
/**
* Gets the original width of picture, in unit of centimeters.
*/
getOriginalWidthCM() {
}
/**
* Gets the original height of picture, in unit of inches.
*/
getOriginalHeightInch() {
}
/**
* Gets the original width of picture, in unit of inches.
*/
getOriginalWidthInch() {
}
/**
* Gets and sets the signature line
*/
getSignatureLine() {
}
/**
* Gets and sets the signature line
*/
setSignatureLine(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Copy the picture.
* @param {Picture} source - The source picture.
* @param {CopyOptions} options - The copy options.
*/
copy(source, options) {
}
/**
* Moves the picture to a specified location.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
*/
move(upperLeftRow, upperLeftColumn) {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents the value of the image bullet.
*/
class PictureBulletValue {
/**
*/
constructor() {
}
/**
* Gets the type of the bullet's value.
* The value of the property is BulletType integer constant.
*/
getType() {
}
/**
* Gets and sets image data of the bullet.
*/
getImageData() {
}
/**
* Gets and sets image data of the bullet.
*/
setImageData(value) {
}
}
/**
* Encapsulates a collection of Picture objects.
* @hideconstructor
*/
class PictureCollection {
/**
*/
getCount() {
}
/**
* Gets the Picture element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Picture} The element at the specified index.
*/
get(index) {
}
/**
* Adds a picture to the collection.
* ///
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
* @param {String} fileName - Image filename.
* @return {Number} Picture object index.
*/
add(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn, fileName) {
}
/**
* Adds a picture to the collection.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {String} fileName - Image filename.
* @return {Number} Picture object index.
*/
add(upperLeftRow, upperLeftColumn, fileName) {
}
/**
* Adds a picture to the collection.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {String} fileName - Image filename.
* @param {Number} widthScale - Scale of image width, a percentage.
* @param {Number} heightScale - Scale of image height, a percentage.
* @return {Number} Picture object index.
*/
add(upperLeftRow, upperLeftColumn, fileName, widthScale, heightScale) {
}
/**
* Clear all pictures.
*/
clear() {
}
/**
* Remove shapes at the specific index
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
/**
* Adds a picture to the collection.
* @param {PictureCollection} pictures - The PictureCollection object
* @param {Number} upperLeftRow - Upper left row index
* @param {Number} upperLeftColumn - Upper left column index
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
* @param {ReadableStream} stream - Stream object which contains the image data
* @param {Callback} callback - The callback function
* @return {Picture} Picture object index.
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook();
* var pictures = workbook.getWorksheets().add("picture").getPictures();
* var pictureStream = fs.createReadStream("boxing.PNG");
* aspose.cells.PictureCollection.addPictureFromStream(pictures, 0, 0, 10, 8, pictureStream,
* function(index, err) {
* if (err) {
* console.log("addPictureFromStream error");
* return;
* }
* console.log("picture add index: " + index);
* workbook.save('result.xlsx');
* console.log('saved to file');
* }
* );
*/
static addPictureFromStream(pictures, upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn, stream, callback) {
}
/**
* Adds a picture to the collection.
* @param {PictureCollection} pictures - The PictureCollection object
* @param {Number} upperLeftRow - Upper left row index
* @param {Number} upperLeftColumn - Upper left column index
* @param {ReadableStream} stream - Stream object which contains the image data
* @param {Callback} callback - The callback function
* @return {Picture} Picture object index.
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook();
* var pictures = workbook.getWorksheets().add("picture").getPictures();
* var pictureStream = fs.createReadStream("boxing.PNG");
* aspose.cells.PictureCollection.addPictureFromStream(pictures, 0, 0, pictureStream,
* function(index, err) {
* if (err) {
* console.log("addPictureFromStream error");
* return;
* }
* console.log("picture add index: " + index);
* workbook.save('result.xlsx');
* console.log('saved to file');
* }
* );
*/
static addPictureFromStream(pictures, upperLeftRow, upperLeftColumn, stream, callback) {
}
/**
* Adds a picture to the collection.
* @param {PictureCollection} pictures - The PictureCollection object
* @param {Number} upperLeftRow - Upper left row index
* @param {Number} upperLeftColumn - Upper left column index
* @param {ReadableStream} stream - Stream object which contains the image data
* @param {Number} widthScale - Scale of image width, a percentage
* @param {Number} heightScale - Scale of image height, a percentage
* @param {Callback} callback - The callback function
* @return {Picture} Picture object index.
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook();
* var pictures = workbook.getWorksheets().add("picture").getPictures();
* var pictureStream = fs.createReadStream("boxing.PNG");
* aspose.cells.PictureCollection.addPictureFromStream(pictures, 0, 0, pictureStream, 80, 60,
* function(index, err) {
* if (err) {
* console.log("addPictureFromStream error");
* return;
* }
* console.log("picture add index: " + index);
* workbook.save('result.xlsx');
* console.log('saved to file');
* }
* );
*/
static addPictureFromStream(pictures, upperLeftRow, upperLeftColumn, stream, widthScale, heightScale, callback) {
}
}
/**
* Presents the selected area of the PivotTable.
*/
class PivotArea {
/**
* Presents the selected area of the PivotTable.
* @param {PivotTable} table
*/
constructor(table) {
}
/**
* Gets all filters for this PivotArea.
*/
getFilters() {
}
/**
* 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() {
}
/**
* 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.
*/
setOnlyData(value) {
}
/**
* Indicates whether only the data labels for an item selection are selected.
*/
getOnlyLabel() {
}
/**
* Indicates whether only the data labels for an item selection are selected.
*/
setOnlyLabel(value) {
}
/**
* Indicates whether the row grand total is included.
*/
isRowGrandIncluded() {
}
/**
* Indicates whether the row grand total is included.
*/
setRowGrandIncluded(value) {
}
/**
* Indicates whether the column grand total is included.
*/
isColumnGrandIncluded() {
}
/**
* Indicates whether the column grand total is included.
*/
setColumnGrandIncluded(value) {
}
/**
* Gets and sets the region of the PivotTable to which this rule applies.
* The value of the property is PivotFieldType integer constant.
*/
getAxisType() {
}
/**
* Gets and sets the region of the PivotTable to which this rule applies.
* The value of the property is PivotFieldType integer constant.
*/
setAxisType(value) {
}
/**
* Gets and sets the type of selection rule.
* The value of the property is PivotAreaType integer constant.
*/
getRuleType() {
}
/**
* Gets and sets the type of selection rule.
* The value of the property is PivotAreaType integer constant.
*/
setRuleType(value) {
}
/**
* Indicates whether the rule refers to an area that is in outline mode.
*/
isOutline() {
}
/**
* Indicates whether the rule refers to an area that is in outline mode.
*/
setOutline(value) {
}
/**
* Select the area with filters.
* @param {Number} axisType - PivotFieldType
* @param {Number} fieldPosition - Position of the field within the axis to which this rule applies.
* @param {Number} selectionType - PivotTableSelectionType
*/
select(axisType, fieldPosition, selectionType) {
}
}
/**
* Represents the filter of PivotArea for PivotTable.
*/
class PivotAreaFilter {
/**
*/
constructor() {
}
/**
* Indicates whether this field has selection.
* Only works when the PivotTable is in Outline view.
*/
getSelected() {
}
/**
* Indicates whether this field has selection.
* Only works when the PivotTable is in Outline view.
*/
setSelected(value) {
}
/**
* Gets which subtotal is set for this filter.
* @param {Number} subtotalType - PivotFieldSubtotalType
* @return {boolean}
*/
isSubtotalSet(subtotalType) {
}
/**
* Subtotal for the filter.
* @param {Number} subtotalType - PivotFieldSubtotalType
* @param {boolean} shown - Indicates if showing this subtotal data.
*/
setSubtotals(subtotalType, shown) {
}
}
/**
* Represents the list of filters for PivotArea
*/
class PivotAreaFilterCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets filter from the list by the index.
* @param {Number} index - The Index
* @return {PivotAreaFilter}
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the field grouped by date time range.
* @hideconstructor
*/
class PivotDateTimeRangeGroupSettings {
/**
* Gets the data time group type.
* The value of the property is PivotFieldGroupType integer constant.
*/
getType() {
}
/**
* Gets the start date time of the group.
*/
getStart() {
}
/**
* Gets the end date time of the group.
*/
getEnd() {
}
/**
* Gets the internal of the group.
*/
getInterval() {
}
/**
* Gets the types of grouping by date time.
*/
getGroupByTypes() {
}
/**
* Check whether the field is grouped by the type.
* @param {Number} type - PivotGroupByType
* @return {boolean}
*/
isGroupedBy(type) {
}
}
/**
* Rrepsents the discrete group of pivot field
* @hideconstructor
*/
class PivotDiscreteGroupSettings {
/**
* Gets the group type.
* The value of the property is PivotFieldGroupType integer constant.
*/
getType() {
}
/**
* Gets the discrete items.
*/
getItems() {
}
}
/**
* Represents a field in a PivotTable report.
* @hideconstructor
*/
class PivotField {
/**
* Gets the pivot items of the pivot field
*/
getPivotItems() {
}
/**
* Gets the group range of the pivot field
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GroupSettings property.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getRange() {
}
/**
* Gets the group settings of the pivot field.
* If this field is not grouped, Null will be returned.
*/
getGroupSettings() {
}
/**
* Indicates whether the specified PivotTable field is calculated field.
*/
isCalculatedField() {
}
/**
* Represents the PivotField index in the base PivotFields.
*/
getBaseIndex() {
}
/**
* Represents the PivotField index in the base PivotFields.
*/
setBaseIndex(value) {
}
/**
* Represents the index of PivotField in the region.
*/
getPosition() {
}
/**
* Represents the name of PivotField.
*/
getName() {
}
/**
* Represents the name of PivotField.
*/
setName(value) {
}
/**
* Represents the PivotField display name.
*/
getDisplayName() {
}
/**
* Represents the PivotField display name.
*/
setDisplayName(value) {
}
/**
* Indicates whether the specified field shows automatic subtotals. Default is true.
*/
isAutoSubtotals() {
}
/**
* Indicates whether the specified field shows automatic subtotals. Default is true.
*/
setAutoSubtotals(value) {
}
/**
* Indicates whether the specified field can be dragged to the column position.
* The default value is true.
*/
getDragToColumn() {
}
/**
* Indicates whether the specified field can be dragged to the column position.
* The default value is true.
*/
setDragToColumn(value) {
}
/**
* Indicates whether the specified field can be dragged to the hide position.
* The default value is true.
*/
getDragToHide() {
}
/**
* Indicates whether the specified field can be dragged to the hide position.
* The default value is true.
*/
setDragToHide(value) {
}
/**
* Indicates whether the specified field can be dragged to the row position.
* The default value is true.
*/
getDragToRow() {
}
/**
* Indicates whether the specified field can be dragged to the row position.
* The default value is true.
*/
setDragToRow(value) {
}
/**
* Indicates whether the specified field can be dragged to the page position.
* The default value is true.
*/
getDragToPage() {
}
/**
* Indicates whether the specified field can be dragged to the page position.
* The default value is true.
*/
setDragToPage(value) {
}
/**
* Indicates whether the specified field can be dragged to the data position.
* The default value is true.
*/
getDragToData() {
}
/**
* Indicates whether the specified field can be dragged to the data position.
* The default value is true.
*/
setDragToData(value) {
}
/**
* indicates whether the field can have multiple items
* selected in the page field
* The default value is false.
*/
isMultipleItemSelectionAllowed() {
}
/**
* indicates whether the field can have multiple items
* selected in the page field
* The default value is false.
*/
setMultipleItemSelectionAllowed(value) {
}
/**
* indicates whether the field can repeat items labels
* The default value is false.
*/
isRepeatItemLabels() {
}
/**
* indicates whether the field can repeat items labels
* The default value is false.
*/
setRepeatItemLabels(value) {
}
/**
* indicates whether the field can include new items in manual filter
* The default value is false.
*/
isIncludeNewItemsInFilter() {
}
/**
* indicates whether the field can include new items in manual filter
* The default value is false.
*/
setIncludeNewItemsInFilter(value) {
}
/**
* indicates whether the field can insert page breaks between items
* insert page break after each item
* The default value is false.
*/
isInsertPageBreaksBetweenItems() {
}
/**
* indicates whether the field can insert page breaks between items
* insert page break after each item
* The default value is false.
*/
setInsertPageBreaksBetweenItems(value) {
}
/**
* Indicates whether all items displays in the PivotTable report,
* even if they don't contain summary data.
* show items with no data
* The default value is false.
*/
getShowAllItems() {
}
/**
* Indicates whether all items displays in the PivotTable report,
* even if they don't contain summary data.
* show items with no data
* The default value is false.
*/
setShowAllItems(value) {
}
/**
* Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
*/
getNonAutoSortDefault() {
}
/**
* Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
*/
setNonAutoSortDefault(value) {
}
/**
* Indicates whether the specified PivotTable field is automatically sorted.
*/
isAutoSort() {
}
/**
* Indicates whether the specified PivotTable field is automatically sorted.
*/
setAutoSort(value) {
}
/**
* Indicates whether the specified PivotTable field is autosorted ascending.
*/
isAscendSort() {
}
/**
* Indicates whether the specified PivotTable field is autosorted ascending.
*/
setAscendSort(value) {
}
/**
* Represents auto sort field index.
* -1 means PivotField itself,others means the position of the data fields.
*/
getAutoSortField() {
}
/**
* Represents auto sort field index.
* -1 means PivotField itself,others means the position of the data fields.
*/
setAutoSortField(value) {
}
/**
* Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
*/
isAutoShow() {
}
/**
* Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
*/
setAutoShow(value) {
}
/**
* Indicates whether the specified PivotTable field is autoshown ascending.
*/
isAscendShow() {
}
/**
* Indicates whether the specified PivotTable field is autoshown ascending.
*/
setAscendShow(value) {
}
/**
* Represent the number of top or bottom items
* that are automatically shown in the specified PivotTable field.
*/
getAutoShowCount() {
}
/**
* Represent the number of top or bottom items
* that are automatically shown in the specified PivotTable field.
*/
setAutoShowCount(value) {
}
/**
* Represents auto show field index. -1 means PivotField itself.
* It should be the index of the data fields.
*/
getAutoShowField() {
}
/**
* Represents auto show field index. -1 means PivotField itself.
* It should be the index of the data fields.
*/
setAutoShowField(value) {
}
/**
* Represents the function used to summarize the PivotTable data field.
* The value of the property is ConsolidationFunction integer constant.
*/
getFunction() {
}
/**
* Represents the function used to summarize the PivotTable data field.
* The value of the property is ConsolidationFunction integer constant.
*/
setFunction(value) {
}
/**
* Represents how to display the values contained in a data field.
* The value of the property is PivotFieldDataDisplayFormat integer constant.PivotFieldDataDisplayFormat
*/
getDataDisplayFormat() {
}
/**
* Represents how to display the values contained in a data field.
* The value of the property is PivotFieldDataDisplayFormat integer constant.PivotFieldDataDisplayFormat
*/
setDataDisplayFormat(value) {
}
/**
* Represents the base field for a custom calculation.
*/
getBaseFieldIndex() {
}
/**
* Represents the base field for a custom calculation.
*/
setBaseFieldIndex(value) {
}
/**
* Represents the item in the base field for a custom calculation.
* Valid only for data fields.
* Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom,
* please set PivotField.BaseItemIndex attribute.
* The value of the property is PivotItemPosition integer constant.PivotItemPosition
*/
getBaseItemPosition() {
}
/**
* Represents the item in the base field for a custom calculation.
* Valid only for data fields.
* Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom,
* please set PivotField.BaseItemIndex attribute.
* The value of the property is PivotItemPosition integer constant.PivotItemPosition
*/
setBaseItemPosition(value) {
}
/**
* Represents the item in the base field for a custom calculation.
* Valid only for data fields.
*/
getBaseItemIndex() {
}
/**
* Represents the item in the base field for a custom calculation.
* Valid only for data fields.
*/
setBaseItemIndex(value) {
}
/**
* Represents the current page item showing for the page field (valid only for page fields).
*/
getCurrentPageItem() {
}
/**
* Represents the current page item showing for the page field (valid only for page fields).
*/
setCurrentPageItem(value) {
}
/**
* Represents the built-in display format of numbers and dates.
*/
getNumber() {
}
/**
* Represents the built-in display format of numbers and dates.
*/
setNumber(value) {
}
/**
* Indicates whether inserting blank line after each item.
*/
getInsertBlankRow() {
}
/**
* Indicates whether inserting blank line after each item.
*/
setInsertBlankRow(value) {
}
/**
* when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
* Only works when ShowInOutlineForm is true.
*/
getShowSubtotalAtTop() {
}
/**
* when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
* Only works when ShowInOutlineForm is true.
*/
setShowSubtotalAtTop(value) {
}
/**
* Indicates whether layout this field in outline form on the Pivot Table view
*/
getShowInOutlineForm() {
}
/**
* Indicates whether layout this field in outline form on the Pivot Table view
*/
setShowInOutlineForm(value) {
}
/**
* Represents the custom display format of numbers and dates.
*/
getNumberFormat() {
}
/**
* Represents the custom display format of numbers and dates.
*/
setNumberFormat(value) {
}
/**
* Get all base items;
*/
getItems() {
}
/**
* Get the original base items;
*/
getOriginalItems() {
}
/**
* Gets the base item count of this pivot field.
*/
getItemCount() {
}
/**
* Indicates whether display labels from the next field in the same column on the Pivot Table view
*/
getShowCompact() {
}
/**
* Indicates whether display labels from the next field in the same column on the Pivot Table view
*/
setShowCompact(value) {
}
/**
* Gets the pivot filter of the pivot field by type
*/
getPivotFilterByType(type) {
}
/**
* Gets the pivot filters of the pivot field
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GetFilters() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPivotFilters() {
}
/**
* Gets all pivot filters of this pivot field.
*/
getFilters() {
}
/**
* Init the pivot items of the pivot field
*/
initPivotItems() {
}
/**
* Automatically group the field with internal
* @param {Number} interval - The internal of group.
* Automatic value will be assigned if it's zero,
* @param {boolean} newField - Indicates whether adding a new field to the pivottable.
*/
groupBy(interval, newField) {
}
/**
* Group the file by the date group types.
* @param {DateTime} start - The start datetime
* @param {DateTime} end - The end of datetime
* @param {Number[]} groups - Group types
* @param {Number} interval - The interval
* @param {boolean} firstAsNewField - Indicates whether adding a new field to the pivottable.
* Only for the first group item.
*/
groupBy(start, end, groups, interval, firstAsNewField) {
}
/**
* Group the file by number.
* @param {Number} start - The start value
* @param {Number} end - The end of value
* @param {Number} interval - The interval
* @param {boolean} newField - Indicates whether adding a new field to the pivottable
*/
groupBy(start, end, interval, newField) {
}
/**
* Custom group the field.
* @param {CustomPiovtFieldGroupItem[]} customGroupItems - The custom group items.
* @param {boolean} newField - Indicates whether adding a new field to the pivottable
*/
groupBy(customGroupItems, newField) {
}
/**
* Ungroup the pivot field.
*/
ungroup() {
}
/**
* Get the formula string of the specified calculated field .
*/
getCalculatedFieldFormula() {
}
/**
* Sets whether the specified field shows that subtotals.
* PivotFieldSubtotalType
* @param {Number} subtotalType - PivotFieldSubtotalType
* @param {boolean} shown - whether the specified field shows that subtotals.
*/
setSubtotals(subtotalType, shown) {
}
/**
* Indicates whether showing specified subtotal.
* @param {Number} subtotalType - PivotFieldSubtotalType
* @return {boolean} Returns whether showing specified subtotal.
*/
getSubtotals(subtotalType) {
}
/**
* Indicates whether the specific PivotItem is hidden.
* @param {Number} index - the index of the pivotItem in the pivotField.
* @return {boolean} whether the specific PivotItem is hidden
*/
isHiddenItem(index) {
}
/**
* Sets whether the specific PivotItem in a data field is hidden.
* @param {Number} index - the index of the pivotItem in the pivotField.
* @param {boolean} isHidden - whether the specific PivotItem is hidden
*/
hideItem(index, isHidden) {
}
/**
* Indicates whether the specific PivotItem is hidden detail.
* @param {Number} index - the index of the pivotItem in the pivotField.
* @return {boolean} whether the specific PivotItem is hidden detail
*/
isHiddenItemDetail(index) {
}
/**
* Sets whether the specific PivotItem in a pivot field is hidden detail.
* @param {Number} index - the index of the pivotItem in the pivotField.
* @param {boolean} isHiddenDetail - whether the specific PivotItem is hidden
*/
hideItemDetail(index, isHiddenDetail) {
}
/**
* Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
* @param {boolean} isHiddenDetail - whether the PivotItems is hidden
*/
hideDetail(isHiddenDetail) {
}
/**
* Sets whether the specific PivotItem in a data field is hidden.
* @param {String} itemValue - the value of the pivotItem in the pivotField.
* @param {boolean} isHidden - whether the specific PivotItem is hidden
*/
hideItem(itemValue, isHidden) {
}
/**
* Add a calculated item to the pivot field.
* Only supports to add calculated item to Row/Column field.
* @param {String} name - The item's name.
* @param {String} formula - The item's formula
*/
addCalculatedItem(name, formula) {
}
}
/**
* Represents a collection of all the PivotField objects
* in the PivotTable's specific PivotFields type.
* @hideconstructor
*/
class PivotFieldCollection {
/**
* Gets the PivotFields type.
* The value of the property is PivotFieldType integer constant.
*/
getType() {
}
/**
* Gets the count of the pivotFields.
*/
getCount() {
}
/**
* Gets the PivotField Object at the specific index.
*/
get(index) {
}
/**
* Gets the PivotField Object of the specific name.
*/
get(name) {
}
/**
* Gets an enumerator over the elements in this collection in proper sequence.
* @return {Iterator} enumerator
*/
iterator() {
}
/**
* Adds a PivotField Object to the specific type PivotFields.
* @param {Number} baseFieldIndex - field index in the base PivotFields.
* @return {Number} the index of the PivotField Object in this PivotFields.
*/
addByBaseIndex(baseFieldIndex) {
}
/**
* Adds a PivotField Object to the specific type PivotFields.
* @param {PivotField} pivotField - a PivotField Object.
* @return {Number} the index of the PivotField Object in this PivotFields.
*/
add(pivotField) {
}
/**
* clear all fields of PivotFieldCollection
*/
clear() {
}
/**
* Moves the PivotField from current position to destination position
* @param {Number} currPos - Current position of PivotField based on zero
* @param {Number} destPos - Destination position of PivotField based on zero
*/
move(currPos, destPos) {
}
}
/**
* Represents the group setting of pivot field.
*/
class PivotFieldGroupSettings {
/**
*/
constructor() {
}
/**
* Gets the group type of pivot field.
* The value of the property is PivotFieldGroupType integer constant.
*/
getType() {
}
}
/**
* Represents a PivotFilter in PivotFilter Collection.
* @hideconstructor
*/
class PivotFilter {
/**
* Gets the autofilter of the pivot filter.
*/
getAutoFilter() {
}
/**
* Gets the autofilter type of the pivot filter.
* The value of the property is PivotFilterType integer constant.
*/
getFilterType() {
}
/**
* Gets the field index of the pivot filter.
*/
getFieldIndex() {
}
/**
* Gets the string value1 of the label pivot filter.
*/
getValue1() {
}
/**
* Gets the string value1 of the label pivot filter.
*/
setValue1(value) {
}
/**
* Gets the string value2 of the label pivot filter.
*/
getValue2() {
}
/**
* Gets the string value2 of the label pivot filter.
*/
setValue2(value) {
}
/**
* Gets the measure field index of the pivot filter.
*/
getMeasureFldIndex() {
}
/**
* Gets the measure field index of the pivot filter.
*/
setMeasureFldIndex(value) {
}
/**
* Gets the member property field index of the pivot filter.
*/
getMemberPropertyFieldIndex() {
}
/**
* Gets the member property field index of the pivot filter.
*/
setMemberPropertyFieldIndex(value) {
}
/**
* Gets the name of the pivot filter.
*/
getName() {
}
/**
* Gets the name of the pivot filter.
*/
setName(value) {
}
/**
* Gets the Evaluation Order of the pivot filter.
*/
getEvaluationOrder() {
}
/**
* Gets the Evaluation Order of the pivot filter.
*/
setEvaluationOrder(value) {
}
}
/**
* Represents a collection of all the PivotFilter objects
* @hideconstructor
*/
class PivotFilterCollection {
/**
*/
getCount() {
}
/**
* Gets the pivotfilter object at the specific index.
*/
get(index) {
}
/**
* Adds a PivotFilter Object to the specific type
* @param {Number} fieldIndex - the PivotField index
* @param {Number} type - PivotFilterType
* @return {Number} the index of the PivotFilter Object in this PivotFilterCollection.
*/
add(fieldIndex, type) {
}
/**
* Clear PivotFilter from the specific PivotField
* @param {Number} fieldIndex - the PivotField index
*/
clearFilter(fieldIndex) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a PivotTable Format Condition in PivotFormatCondition Collection.
* @hideconstructor
*/
class PivotFormatCondition {
/**
* Get and set scope type for the pivot table condition format .
* The value of the property is PivotConditionFormatScopeType integer constant.
*/
getScopeType() {
}
/**
* Get and set scope type for the pivot table condition format .
* The value of the property is PivotConditionFormatScopeType integer constant.
*/
setScopeType(value) {
}
/**
* Get and set rule type for the pivot table condition format .
* The value of the property is PivotConditionFormatRuleType integer constant.
*/
getRuleType() {
}
/**
* Get and set rule type for the pivot table condition format .
* The value of the property is PivotConditionFormatRuleType integer constant.
*/
setRuleType(value) {
}
/**
* Get formatconditions for the pivot table condition format .
*/
getFormatConditions() {
}
/**
* Adds PivotTable conditional format limit in the data fields.
* @param {String} fieldName - The name of PivotField.
*/
addDataAreaCondition(fieldName) {
}
/**
* Adds PivotTable conditional format limit in the data fields.
* @param {PivotField} dataField - The PivotField in the data fields.
*/
addDataAreaCondition(dataField) {
}
/**
* Adds PivotTable conditional format limit in the row fields.
* @param {String} fieldName - The name of PivotField.
*/
addRowAreaCondition(fieldName) {
}
/**
* Adds PivotTable conditional format limit in the row fields.
* @param {PivotField} rowField - The PivotField in the row fields.
*/
addRowAreaCondition(rowField) {
}
/**
* Adds PivotTable conditional format limit in the column fields.
* @param {String} fieldName - The name of PivotField.
*/
addColumnAreaCondition(fieldName) {
}
/**
* Adds PivotTable conditional format limit in the column fields.
* @param {PivotField} columnField - The PivotField in the column fields.
*/
addColumnAreaCondition(columnField) {
}
/**
* Sets conditional areas of PivotFormatCondition object.
*/
setConditionalAreas() {
}
}
/**
* Represents PivotTable Format Conditions.
* @hideconstructor
*/
class PivotFormatConditionCollection {
/**
*/
getCount() {
}
/**
* Gets the pivot FormatCondition object at the specific index.
* @return {PivotFormatCondition} pivot FormatCondition object.
*/
get(index) {
}
/**
* Adds a pivot FormatCondition to the collection.
* not supported@return {Number} pivot FormatCondition object index.
*/
add() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the globalization settings for pivot tables.
*/
class PivotGlobalizationSettings {
/**
*/
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.
* @return {String} The text of "Total" label
*/
getTextOfTotal() {
}
/**
* Gets the text of "Grand Total" label in the PivotTable.
* @return {String} The text of "Grand Total" label
*/
getTextOfGrandTotal() {
}
/**
* Gets the text of "(Multiple Items)" label in the PivotTable.
* @return {String} The text of "(Multiple Items)" label
*/
getTextOfMultipleItems() {
}
/**
* Gets the text of "(All)" label in the PivotTable.
* @return {String} The text of "(All)" label
*/
getTextOfAll() {
}
/**
* Gets the protection name in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetTextOfProtectedName(string) method.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The protection name of PivotTable
*/
getTextOfProtection() {
}
/**
* Gets the text for specified protected name.
* 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.
* @param {String} protectedName - The protected name in PivotTable.
* @return {String} The local prorected names of PivotTable.
*/
getTextOfProtectedName(protectedName) {
}
/**
* Gets the text of "Column Labels" label in the PivotTable.
* @return {String} The text of column labels
*/
getTextOfColumnLabels() {
}
/**
* Gets the text of "Row Labels" label in the PivotTable.
* @return {String} The text of row labels
*/
getTextOfRowLabels() {
}
/**
* Gets the text of "(blank)" label in the PivotTable.
* @return {String} The text of empty data
*/
getTextOfEmptyData() {
}
/**
* Gets the the text of the value area field header in the PivotTable.
* @return {String} The text of data field header name
*/
getTextOfDataFieldHeader() {
}
/**
* Gets all short formatted string of 12 months.
* @return {String[]}
*/
getShortTextOf12Months() {
}
/**
* Gets the local text of 4 Quaters.
* @return {String[]}
*/
getTextOf4Quaters() {
}
/**
* Gets the local text of "Years".
* @return {String}
*/
getTextOfYears() {
}
/**
* Get the local text of "Quarters".
* @return {String}
*/
getTextOfQuarters() {
}
/**
* Gets the local text of "Months".
* @return {String}
*/
getTextOfMonths() {
}
/**
* Gets the local text of "Days".
* @return {String}
*/
getTextOfDays() {
}
/**
* Gets the local text of "Hours".
* @return {String}
*/
getTextOfHours() {
}
/**
* Gets the local text of "Minutes".
* @return {String}
*/
getTextOfMinutes() {
}
/**
* Gets the local text of "Seconds"
* @return {String}
*/
getTextOfSeconds() {
}
/**
* Gets the local text of "Range"
* @return {String}
*/
getTextOfRange() {
}
/**
* Gets the text of PivotFieldSubtotalType type in the PivotTable.
* @param {Number} subTotalType - PivotFieldSubtotalType
* @return {String} The text of given type
*/
getTextOfSubTotal(subTotalType) {
}
}
/**
* Represents a item in a PivotField report.
* @hideconstructor
*/
class PivotItem {
/**
* Gets and Sets whether the pivot item is hidden.
*/
isHidden() {
}
/**
* Gets and Sets whether the pivot item is hidden.
*/
setHidden(value) {
}
/**
* Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.
*/
setPosition(value) {
}
/**
* Specifying the position index in the PivotItems under the same parent node.
*/
setPositionInSameParentNode(value) {
}
/**
* Gets and Sets whether the pivot item hides detail.
*/
isHideDetail() {
}
/**
* Gets and Sets whether the pivot item hides detail.
*/
setHideDetail(value) {
}
/**
* Indicates whether the item has a missing value.
* True means this value has benn removed from the data source.
*/
isMissing() {
}
/**
* Gets the value of the pivot item
*/
getValue() {
}
/**
* Gets the name of the pivot item.
*/
getName() {
}
/**
* Gets the index of the pivot item in the pivot field
*/
getIndex() {
}
/**
* Gets the index of the pivot item in the pivot field
*/
setIndex(value) {
}
/**
* Sets whether the pivot item is hidden.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Pivot.PivotField.HideItem method.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
hide(value) {
}
/**
* Moves the item up or down
* @param {Number} 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 {boolean} isSameParent -
* Specifying whether moving operation is in the same parent node or not
*/
move(count, isSameParent) {
}
/**
* Gets the string value of the pivot item
* If the value is null, it will return ""
*/
getStringValue() {
}
/**
* Gets the double value of the pivot item
* If the value is null or not number ,it will return 0
*/
getDoubleValue() {
}
/**
* Gets the date time value of the pivot item
* If the value is null ,it will return DateTime.MinValue
*/
getDateTimeValue() {
}
}
/**
* Represents a collection of all the PivotItem objects in the PivotField's
* @hideconstructor
*/
class PivotItemCollection {
/**
* Gets the count of the pivot items.
*/
getCount() {
}
/**
* Gets the PivotItem Object at the specific index.
*/
get(index) {
}
/**
* Gets the PivotItem Object of the specific name.
*/
get(itemValue) {
}
/**
* Gets an enumerator over the elements in this collection in proper sequence.
* @return {Iterator} enumerator
*/
iterator() {
}
/**
* Directly changes the orders of the two items.
* @param {Number} sourceIndex - The current index
* @param {Number} destIndex - The dest index
*/
changeitemsOrder(sourceIndex, destIndex) {
}
}
/**
* Represents the numberic range group of the pivot field.
* @hideconstructor
*/
class PivotNumbericRangeGroupSettings {
/**
* Gets the group type.
* The value of the property is PivotFieldGroupType integer constant.
*/
getType() {
}
/**
* Gets the start number of the group.
*/
getStart() {
}
/**
* Gets the end number of the group.
*/
getEnd() {
}
/**
* Gets the interval of the group.
*/
getInterval() {
}
}
/**
* Represents a complex type that specifies the pivot controls that appear on the chart
* @hideconstructor
*/
class PivotOptions {
/**
* 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() {
}
/**
* 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.
*/
setDropZoneFilter(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDropZoneCategories(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDropZoneData(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDropZoneSeries(value) {
}
/**
* Specifies whether any pivot controls can appear on the pivot chart.
*/
getDropZonesVisible() {
}
/**
* Specifies whether any pivot controls can appear on the pivot chart.
*/
setDropZonesVisible(value) {
}
}
/**
* Represents the pivot page field items
* if the pivot table data source is consolidation ranges.
* It only can contain up to 4 fields.
*/
class PivotPageFields {
/**
* Represents the pivot page field items.
*/
constructor() {
}
/**
* Gets the number of page fields.
*/
getPageFieldCount() {
}
/**
* Adds a page field.
* @param {String[]} pageItems - Page field item label
*/
addPageField(pageItems) {
}
/**
* 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 {Number} rangeIndex - The consolidation data range index.
* @param {Number[]} 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, pageItemIndex) {
}
}
/**
* Summary description for PivotTable.
* @hideconstructor
*/
class PivotTable {
/**
* 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() {
}
/**
* 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.
*/
setExcel2003Compatible(value) {
}
/**
* Gets the name of the user who last refreshed the PivotTable
*/
getRefreshedByWho() {
}
/**
* Gets the date when the PivotTable was last refreshed.
*/
getRefreshDate() {
}
/**
* Gets and sets the pivottable style name.
*/
getPivotTableStyleName() {
}
/**
* Gets and sets the pivottable style name.
*/
setPivotTableStyleName(value) {
}
/**
* Gets and sets the built-in pivot table style.
* The value of the property is PivotTableStyleType integer constant.
*/
getPivotTableStyleType() {
}
/**
* Gets and sets the built-in pivot table style.
* The value of the property is PivotTableStyleType integer constant.
*/
setPivotTableStyleType(value) {
}
/**
* Returns a PivotFields object that are currently shown as column fields.
*/
getColumnFields() {
}
/**
* Returns a PivotFields object that are currently shown as row fields.
*/
getRowFields() {
}
/**
* Returns a PivotFields object that are currently shown as page fields.
*/
getPageFields() {
}
/**
* 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() {
}
/**
* 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.
*/
getDataField() {
}
/**
* Returns a PivotFields object that includes all fields in the PivotTable report
*/
getBaseFields() {
}
/**
* Returns a PivotFilterCollection object.
*/
getPivotFilters() {
}
/**
* Returns a CellArea object that represents the range
* that contains the column area in the PivotTable report. Read-only.
*/
getColumnRange() {
}
/**
* Returns a CellArea object that represents the range
* that contains the row area in the PivotTable report. Read-only.
*/
getRowRange() {
}
/**
* Returns a CellArea object that represents the range that contains the data area
* in the list between the header row and the insert row. Read-only.
*/
getDataBodyRange() {
}
/**
* Returns a CellArea object that represents the range containing the entire PivotTable report,
* but doesn't include page fields. Read-only.
*/
getTableRange1() {
}
/**
* Returns a CellArea object that represents the range containing the entire PivotTable report,
* includes page fields. Read-only.
*/
getTableRange2() {
}
/**
* Indicates whether the PivotTable report shows grand totals for columns.
*/
getColumnGrand() {
}
/**
* Indicates whether the PivotTable report shows grand totals for columns.
*/
setColumnGrand(value) {
}
/**
* Indicates whether the PivotTable report displays classic pivottable layout.
* (enables dragging fields in the grid)
*/
isGridDropZones() {
}
/**
* Indicates whether the PivotTable report displays classic pivottable layout.
* (enables dragging fields in the grid)
*/
setGridDropZones(value) {
}
/**
* Indicates whether the PivotTable report shows grand totals for rows.
*/
getRowGrand() {
}
/**
* Indicates whether the PivotTable report shows grand totals for rows.
*/
setRowGrand(value) {
}
/**
* Indicates whether the PivotTable report displays a custom string
* in cells that contain null values.
*/
getDisplayNullString() {
}
/**
* Indicates whether the PivotTable report displays a custom string
* in cells that contain null values.
*/
setDisplayNullString(value) {
}
/**
* Gets the string displayed in cells that contain null values
* when the DisplayNullString property is true.The default value is an empty string.
*/
getNullString() {
}
/**
* Gets the string displayed in cells that contain null values
* when the DisplayNullString property is true.The default value is an empty string.
*/
setNullString(value) {
}
/**
* Indicates whether the PivotTable report displays a custom string in cells that contain errors.
*/
getDisplayErrorString() {
}
/**
* Indicates whether the PivotTable report displays a custom string in cells that contain errors.
*/
setDisplayErrorString(value) {
}
/**
* Gets and sets the name of the value area field header in the PivotTable.
*/
getDataFieldHeaderName() {
}
/**
* Gets and sets the name of the value area field header in the PivotTable.
*/
setDataFieldHeaderName(value) {
}
/**
* Gets the string displayed in cells that contain errors
* when the DisplayErrorString property is true.The default value is an empty string.
*/
getErrorString() {
}
/**
* Gets the string displayed in cells that contain errors
* when the DisplayErrorString property is true.The default value is an empty string.
*/
setErrorString(value) {
}
/**
* Indicates whether the PivotTable report is automatically formatted.
* Checkbox "autoformat table " which is in pivottable option for Excel 2003
*/
isAutoFormat() {
}
/**
* Indicates whether the PivotTable report is automatically formatted.
* Checkbox "autoformat table " which is in pivottable option for Excel 2003
*/
setAutoFormat(value) {
}
/**
* Indicates whether autofitting column width on update
*/
getAutofitColumnWidthOnUpdate() {
}
/**
* Indicates whether autofitting column width on update
*/
setAutofitColumnWidthOnUpdate(value) {
}
/**
* Gets the PivotTable auto format type.
* The value of the property is PivotTableAutoFormatType integer constant.PivotTableAutoFormatType
*/
getAutoFormatType() {
}
/**
* Gets the PivotTable auto format type.
* The value of the property is PivotTableAutoFormatType integer constant.PivotTableAutoFormatType
*/
setAutoFormatType(value) {
}
/**
* Indicates whether to add blank rows.
* This property only applies for the PivotTable auto format types which needs to add blank rows.
*/
hasBlankRows() {
}
/**
* Indicates whether to add blank rows.
* This property only applies for the PivotTable auto format types which needs to add blank rows.
*/
setHasBlankRows(value) {
}
/**
* Indicates whether the specified PivotTable report's outer-row item, column item, subtotal,
* and grand total labels use merged cells.
*/
getMergeLabels() {
}
/**
* Indicates whether the specified PivotTable report's outer-row item, column item, subtotal,
* and grand total labels use merged cells.
*/
setMergeLabels(value) {
}
/**
* Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
*/
getPreserveFormatting() {
}
/**
* Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
*/
setPreserveFormatting(value) {
}
/**
* Gets whether expand/collapse buttons is shown.
*/
getShowDrill() {
}
/**
* Gets whether expand/collapse buttons is shown.
*/
setShowDrill(value) {
}
/**
* Gets whether drilldown is enabled.
*/
getEnableDrilldown() {
}
/**
* Gets whether drilldown is enabled.
*/
setEnableDrilldown(value) {
}
/**
* Indicates whether the PivotTable Field dialog box is available
* when the user double-clicks the PivotTable field.
*/
getEnableFieldDialog() {
}
/**
* Indicates whether the PivotTable Field dialog box is available
* when the user double-clicks the PivotTable field.
*/
setEnableFieldDialog(value) {
}
/**
* Gets whether enable the field list for the PivotTable.
*/
getEnableFieldList() {
}
/**
* Gets whether enable the field list for the PivotTable.
*/
setEnableFieldList(value) {
}
/**
* Indicates whether the PivotTable Wizard is available.
*/
getEnableWizard() {
}
/**
* Indicates whether the PivotTable Wizard is available.
*/
setEnableWizard(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setSubtotalHiddenPageItems(value) {
}
/**
* Returns the text string label that is displayed in the grand total column or row heading.
* The default value is the string "Grand Total".
*/
getGrandTotalName() {
}
/**
* Returns the text string label that is displayed in the grand total column or row heading.
* The default value is the string "Grand Total".
*/
setGrandTotalName(value) {
}
/**
* Indicates whether the PivotTable report is recalculated only at the user's request.
*/
getManualUpdate() {
}
/**
* Indicates whether the PivotTable report is recalculated only at the user's request.
*/
setManualUpdate(value) {
}
/**
* Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
*/
isMultipleFieldFilters() {
}
/**
* Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
*/
setMultipleFieldFilters(value) {
}
/**
* Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
* The value of the property is PivotMissingItemLimitType integer constant.
*/
getMissingItemsLimit() {
}
/**
* Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
* The value of the property is PivotMissingItemLimitType integer constant.
*/
setMissingItemsLimit(value) {
}
/**
* 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() {
}
/**
* 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
*/
setEnableDataValueEditing(value) {
}
/**
* Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
*/
getShowDataTips() {
}
/**
* Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
*/
setShowDataTips(value) {
}
/**
* Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
*/
getShowMemberPropertyTips() {
}
/**
* Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
*/
setShowMemberPropertyTips(value) {
}
/**
* Specifies a boolean value that indicates whether show values row.
* show the values row
*/
getShowValuesRow() {
}
/**
* Specifies a boolean value that indicates whether show values row.
* show the values row
*/
setShowValuesRow(value) {
}
/**
* Specifies a boolean value that indicates whether to include empty columns in the table
*/
getShowEmptyCol() {
}
/**
* Specifies a boolean value that indicates whether to include empty columns in the table
*/
setShowEmptyCol(value) {
}
/**
* Specifies a boolean value that indicates whether to include empty rows in the table.
*/
getShowEmptyRow() {
}
/**
* Specifies a boolean value that indicates whether to include empty rows in the table.
*/
setShowEmptyRow(value) {
}
/**
* Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.
*/
getFieldListSortAscending() {
}
/**
* Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.
*/
setFieldListSortAscending(value) {
}
/**
* Specifies a boolean value that indicates whether drill indicators should be printed.
* print expand/collapse buttons when displayed on pivottable.
*/
getPrintDrill() {
}
/**
* Specifies a boolean value that indicates whether drill indicators should be printed.
* print expand/collapse buttons when displayed on pivottable.
*/
setPrintDrill(value) {
}
/**
* Gets the title of the altertext
*/
getAltTextTitle() {
}
/**
* Gets the title of the altertext
*/
setAltTextTitle(value) {
}
/**
* Gets the description of the alt text
*/
getAltTextDescription() {
}
/**
* Gets the description of the alt text
*/
setAltTextDescription(value) {
}
/**
* Gets the name of the PivotTable
*/
getName() {
}
/**
* Gets the name of the PivotTable
*/
setName(value) {
}
/**
* Gets the Column Header Caption of the PivotTable.
*/
getColumnHeaderCaption() {
}
/**
* Gets the Column Header Caption of the PivotTable.
*/
setColumnHeaderCaption(value) {
}
/**
* Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
*/
getIndent() {
}
/**
* Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
*/
setIndent(value) {
}
/**
* Gets the Row Header Caption of the PivotTable.
*/
getRowHeaderCaption() {
}
/**
* Gets the Row Header Caption of the PivotTable.
*/
setRowHeaderCaption(value) {
}
/**
* Indicates whether row header caption is shown in the PivotTable report
* Indicates whether Display field captions and filter drop downs
*/
getShowRowHeaderCaption() {
}
/**
* Indicates whether row header caption is shown in the PivotTable report
* Indicates whether Display field captions and filter drop downs
*/
setShowRowHeaderCaption(value) {
}
/**
* Indicates whether consider built-in custom list when sort data
*/
getCustomListSort() {
}
/**
* Indicates whether consider built-in custom list when sort data
*/
setCustomListSort(value) {
}
/**
* Gets the Format Conditions of the pivot table.
*/
getPivotFormatConditions() {
}
/**
* Gets the order in which page fields are added to the PivotTable report's layout.
* The value of the property is PrintOrderType integer constant.
*/
getPageFieldOrder() {
}
/**
* Gets the order in which page fields are added to the PivotTable report's layout.
* The value of the property is PrintOrderType integer constant.
*/
setPageFieldOrder(value) {
}
/**
* Gets the number of page fields in each column or row in the PivotTable report.
*/
getPageFieldWrapCount() {
}
/**
* Gets the number of page fields in each column or row in the PivotTable report.
*/
setPageFieldWrapCount(value) {
}
/**
* Gets a string saved with the PivotTable report.
*/
getTag() {
}
/**
* Gets a string saved with the PivotTable report.
*/
setTag(value) {
}
/**
* Indicates whether data for the PivotTable report is saved with the workbook.
*/
getSaveData() {
}
/**
* Indicates whether data for the PivotTable report is saved with the workbook.
*/
setSaveData(value) {
}
/**
* Indicates whether Refresh Data when Opening File.
*/
getRefreshDataOnOpeningFile() {
}
/**
* Indicates whether Refresh Data when Opening File.
*/
setRefreshDataOnOpeningFile(value) {
}
/**
* Indicates whether Refreshing Data or not.
*/
getRefreshDataFlag() {
}
/**
* Indicates whether Refreshing Data or not.
*/
setRefreshDataFlag(value) {
}
/**
* Gets the external connection data source.
*/
getExternalConnectionDataSource() {
}
/**
* Gets and sets the data source of the pivot table.
*/
getDataSource() {
}
/**
* Gets and sets the data source of the pivot table.
*/
setDataSource(value) {
}
/**
* Gets the collection of formats applied to PivotTable.
*/
getPivotFormats() {
}
/**
* A bit that specifies whether pivot item captions on the row axis
* are repeated on each printed page for pivot fields in tabular form.
*/
getItemPrintTitles() {
}
/**
* A bit that specifies whether pivot item captions on the row axis
* are repeated on each printed page for pivot fields in tabular form.
*/
setItemPrintTitles(value) {
}
/**
* Indicates whether the print titles for the worksheet are set based
* on the PivotTable report. The default value is false.
*/
getPrintTitles() {
}
/**
* Indicates whether the print titles for the worksheet are set based
* on the PivotTable report. The default value is false.
*/
setPrintTitles(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDisplayImmediateItems(value) {
}
/**
* Indicates whether the PivotTable is selected.
*/
isSelected() {
}
/**
* Indicates whether the PivotTable is selected.
*/
setSelected(value) {
}
/**
* Indicates whether the row header in the pivot table should have the style applied.
*/
getShowPivotStyleRowHeader() {
}
/**
* Indicates whether the row header in the pivot table should have the style applied.
*/
setShowPivotStyleRowHeader(value) {
}
/**
* Indicates whether the column header in the pivot table should have the style applied.
*/
getShowPivotStyleColumnHeader() {
}
/**
* Indicates whether the column header in the pivot table should have the style applied.
*/
setShowPivotStyleColumnHeader(value) {
}
/**
* Indicates whether row stripe formatting is applied.
*/
getShowPivotStyleRowStripes() {
}
/**
* Indicates whether row stripe formatting is applied.
*/
setShowPivotStyleRowStripes(value) {
}
/**
* Indicates whether column stripe formatting is applied.
*/
getShowPivotStyleColumnStripes() {
}
/**
* Indicates whether column stripe formatting is applied.
*/
setShowPivotStyleColumnStripes(value) {
}
/**
* Indicates whether column stripe formatting is applied.
*/
getShowPivotStyleLastColumn() {
}
/**
* Indicates whether column stripe formatting is applied.
*/
setShowPivotStyleLastColumn(value) {
}
/**
* Set pivottable's source data.
* Sheet1!$A$1:$C$3
*/
changeDataSource(source) {
}
/**
* Get pivottable's source data.
*/
getSource() {
}
/**
* Refreshes pivottable's data and setting from it's data source.
* We will gather data from data source to a pivot cache ,then calculate the data in the cache to the cells.
* This method is only used to gather all data to a pivot cache.
*/
refreshData() {
}
/**
* Refreshes pivottable's data and setting from it's data source with options.
* @param {PivotTableRefreshOption} option - The options for refreshing data source of pivot table.
*/
refreshData(option) {
}
/**
* Calculates pivottable's data to cells.
* Cell.Value in the pivot range could not return the correct result if the method is not been called.
* This method calculates data with an inner pivot cache,not original data source.
* So if the data source is changed, please call RefreshData() method first.
*/
calculateData() {
}
/**
* Clear PivotTable's data and formatting
* If this method is not called before you add or delete PivotField, Maybe the PivotTable data is not corrected
*/
clearData() {
}
/**
* Calculates pivottable's range.
* If this method is not been called,maybe the pivottable range is not corrected.
*/
calculateRange() {
}
/**
* Format all the cell in the pivottable area
* @param {Style} style - Style which is to format
*/
formatAll(style) {
}
/**
* Format the row data in the pivottable area
* @param {Number} row - Row Index of the Row object
* @param {Style} style - Style which is to format
*/
formatRow(row, style) {
}
/**
* Formats selected area of the PivotTable.
* @param {PivotArea} pivotArea
* @param {Style} style
*/
format(pivotArea, style) {
}
/**
* Format the cell in the pivottable area
* @param {Number} row - Row Index of the cell
* @param {Number} column - Column index of the cell
* @param {Style} style - Style which is to format the cell
*/
format(row, column, style) {
}
/**
* Sets auto field group by the PivotTable.
* baseFieldIndex - The row or column field index in the base fields
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GroupBy() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setAutoGroupField(baseFieldIndex) {
}
/**
* Sets auto field group by the PivotTable.
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GroupBy() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {PivotField} pivotField - The row or column field in the specific fields
*/
setAutoGroupField(pivotField) {
}
/**
* Sets manual field group by the PivotTable.
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GroupBy() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} baseFieldIndex - The row or column field index in the base fields
* @param {Number} startVal - Specifies the starting value for numeric grouping.
* @param {Number} endVal - Specifies the ending value for numeric grouping.
* @param {ArrayList} groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
* @param {Number} intervalNum - Specifies the interval number group by numeric grouping.
*/
setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum) {
}
/**
* Sets manual field group by the PivotTable.
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GroupBy() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {PivotField} pivotField - The row or column field in the base fields
* @param {Number} startVal - Specifies the starting value for numeric grouping.
* @param {Number} endVal - Specifies the ending value for numeric grouping.
* @param {ArrayList} groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
* @param {Number} intervalNum - Specifies the interval number group by numeric grouping.
*/
setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum) {
}
/**
* Sets manual field group by the PivotTable.
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GroupBy() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} baseFieldIndex - The row or column field index in the base fields
* @param {DateTime} startVal - Specifies the starting value for date grouping.
* @param {DateTime} endVal - Specifies the ending value for date grouping.
* @param {ArrayList} groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
* @param {Number} intervalNum - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
*/
setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum) {
}
/**
* Sets manual field group by the PivotTable.
* NOTE: This method is now obsolete. Instead,
* please use PivotField.GroupBy() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {PivotField} pivotField - The row or column field in the base fields
* @param {DateTime} startVal - Specifies the starting value for date grouping.
* @param {DateTime} endVal - Specifies the ending value for date grouping.
* @param {ArrayList} groupByList - Specifies the grouping type list. Specified by PivotTableGroupType
* @param {Number} intervalNum - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
*/
setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum) {
}
/**
* Sets ungroup by the PivotTable
* NOTE: This method is now obsolete. Instead,
* please use PivotField.Ungroup() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} baseFieldIndex - The row or column field index in the base fields
*/
setUngroup(baseFieldIndex) {
}
/**
* Sets ungroup by the PivotTable
* NOTE: This method is now obsolete. Instead,
* please use PivotField.Ungroup() method.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {PivotField} pivotField - The row or column field in the base fields
*/
setUngroup(pivotField) {
}
/**
* get pivot table row index list of horizontal pagebreaks
* @return {ArrayList}
*/
getHorizontalBreaks() {
}
/**
* Layouts the PivotTable in compact form.
*/
showInCompactForm() {
}
/**
* Layouts the PivotTable in outline form.
*/
showInOutlineForm() {
}
/**
* Layouts the PivotTable in tabular form.
*/
showInTabularForm() {
}
/**
* Gets the Cell object by the display name of PivotField.
* @param {String} displayName - the DisplayName of PivotField
* @return {Cell} the Cell object
*/
getCellByDisplayName(displayName) {
}
/**
* Gets the Children Pivot Tables which use this PivotTable data as data source.
* @return {PivotTable[]} the PivotTable array object
*/
getChildren() {
}
/**
* Performs application-defined tasks associated with freeing, releasing, or
* resetting unmanaged resources.
*/
dispose() {
}
/**
* Copies named style from another pivot table.
* @param {PivotTable} pivotTable - Source pivot table.
*/
copyStyle(pivotTable) {
}
/**
* Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
* @param {PivotField} pageField - The PivotField object
*/
showReportFilterPage(pageField) {
}
/**
* Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.
* @param {String} fieldName - The name of PivotField
*/
showReportFilterPageByName(fieldName) {
}
/**
* Show all the report filter pages according to the position index in the PageFields
* @param {Number} posIndex - The position index in the PageFields
*/
showReportFilterPageByIndex(posIndex) {
}
/**
* Removes a field from specific field area
* removeField(int, com.aspose.cells.PivotField)
* @param {Number} fieldType - PivotFieldType
* @param {String} fieldName - The name in the base fields.
*/
removeField(fieldType, fieldName) {
}
/**
* Removes a field from specific field area
* removeField(int, com.aspose.cells.PivotField)
* @param {Number} fieldType - PivotFieldType
* @param {Number} baseFieldIndex - The field index in the base fields.
*/
removeField(fieldType, baseFieldIndex) {
}
/**
* Remove field from specific field area
* @param {Number} fieldType - PivotFieldType
* @param {PivotField} pivotField - the field in the base fields.
*/
removeField(fieldType, pivotField) {
}
/**
* Adds the field to the specific area.
* addFieldToArea(int, com.aspose.cells.PivotField)
* @param {Number} fieldType - PivotFieldType
* @param {String} fieldName - The name in the base fields.
* @return {Number} The field position in the specific fields.If there is no field named as it, return -1.
*/
addFieldToArea(fieldType, fieldName) {
}
/**
* Adds the field to the specific area.
* addFieldToArea(int, com.aspose.cells.PivotField)
* @param {Number} fieldType - PivotFieldType
* @param {Number} baseFieldIndex - The field index in the base fields.
* @return {Number} The field position in the specific fields.
*/
addFieldToArea(fieldType, baseFieldIndex) {
}
/**
* Adds the field to the specific area.
* @param {Number} fieldType - PivotFieldType
* @param {PivotField} pivotField - the field in the base fields.
* @return {Number} the field position in the specific fields.
*/
addFieldToArea(fieldType, pivotField) {
}
/**
* Adds a calculated field to pivot field.
* @param {String} name - The name of the calculated field
* @param {String} formula - The formula of the calculated field.
* @param {boolean} dragToDataArea - True,drag this field to data area immediately
*/
addCalculatedField(name, formula, dragToDataArea) {
}
/**
* Adds a calculated field to pivot field and drag it to data area.
* @param {String} name - The name of the calculated field
* @param {String} formula - The formula of the calculated field.
*/
addCalculatedField(name, formula) {
}
/**
* Gets the specific fields by the field type.
* @param {Number} fieldType - PivotFieldType
* @return {PivotFieldCollection} the specific fields
*/
fields(fieldType) {
}
/**
* Moves the PivotTable to a different location in the worksheet.
* @param {Number} row - row index.
* @param {Number} column - column index.
*/
move(row, column) {
}
/**
* Moves the PivotTable to a different location in the worksheet.
* @param {String} destCellName - the dest cell name.
*/
move(destCellName) {
}
}
/**
* Represents the collection of all the PivotTable objects on the specified worksheet.
* @hideconstructor
*/
class PivotTableCollection {
/**
*/
getCount() {
}
/**
* Gets the PivotTable report by index.
*/
get(index) {
}
/**
* Gets the PivotTable report by pivottable's name.
*/
get(name) {
}
/**
* Gets the PivotTable report by pivottable's position.
*/
get(row, column) {
}
/**
* Performs application-defined tasks associated with freeing, releasing, or
* resetting unmanaged resources.
*/
dispose() {
}
/**
* Adds a new PivotTable cache to a PivotCaches collection.
* @param {String} sourceData - The data for the new PivotTable cache.
* @param {String} destCellName - The cell in the upper-left corner of the PivotTable report's destination range.
* @param {String} tableName - The name of the new PivotTable report.
* @return {Number} The new added cache index.
*/
add(sourceData, destCellName, tableName) {
}
/**
* Adds a new PivotTable cache to a PivotCaches collection.
* @param {String} sourceData - The data for the new PivotTable cache.
* @param {String} destCellName - The cell in the upper-left corner of the PivotTable report's destination range.
* @param {String} tableName - The name of the new PivotTable report.
* @param {boolean} 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.
* @return {Number} The new added cache index.
*/
add(sourceData, destCellName, tableName, useSameSource) {
}
/**
* Adds a new PivotTable cache to a PivotCaches collection.
* @param {String} sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8
* @param {Number} row - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {Number} column - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {String} tableName - The name of the new PivotTable report.
* @return {Number} The new added cache index.
*/
add(sourceData, row, column, tableName) {
}
/**
* Adds a new PivotTable cache to a PivotCaches collection.
* @param {String} sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8
* @param {Number} row - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {Number} column - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {String} tableName - The name of the new PivotTable report.
* @param {boolean} 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.
* @return {Number} The new added cache index.
*/
add(sourceData, row, column, tableName, useSameSource) {
}
/**
* Adds a new PivotTable Object to the collection from another PivotTable.
* @param {PivotTable} pivotTable - The source pivotTable.
* @param {String} destCellName - The cell in the upper-left corner of the PivotTable report's destination range.
* @param {String} tableName - The name of the new PivotTable report.
* @return {Number} The new added PivotTable index.
*/
add(pivotTable, destCellName, tableName) {
}
/**
* Adds a new PivotTable Object to the collection from another PivotTable.
* @param {PivotTable} pivotTable - The source pivotTable.
* @param {Number} row - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {Number} column - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {String} tableName - The name of the new PivotTable report.
* @return {Number} The new added PivotTable index.
*/
add(pivotTable, row, column, tableName) {
}
/**
* Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
* @param {String[]} sourceData - The multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"}
* @param {boolean} isAutoPage - Whether auto create a single page field.
* If true,the following param pageFields will be ignored.
* @param {PivotPageFields} pageFields - The pivot page field items.
* @param {String} destCellName - destCellName The name of the new PivotTable report.
* @param {String} tableName - the name of the new PivotTable report.
* @return {Number} The new added PivotTable index.
*/
add(sourceData, isAutoPage, pageFields, destCellName, tableName) {
}
/**
* Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
* @param {String[]} sourceData - The multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"}
* @param {boolean} isAutoPage - Whether auto create a single page field.
* If true,the following param pageFields will be ignored
* @param {PivotPageFields} pageFields - The pivot page field items.
* @param {Number} row - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {Number} column - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
* @param {String} tableName - The name of the new PivotTable report.
* @return {Number} The new added PivotTable index.
*/
add(sourceData, isAutoPage, pageFields, row, column, tableName) {
}
/**
* Clear all pivot tables.
*/
clear() {
}
/**
* Deletes the specified PivotTable and delete the PivotTable data
* @param {PivotTable} pivotTable - PivotTable object
*/
remove(pivotTable) {
}
/**
* Deletes the specified PivotTable
* @param {PivotTable} pivotTable - PivotTable object
* @param {boolean} keepData - Whether to keep the PivotTable data
*/
remove(pivotTable, keepData) {
}
/**
* Deletes the PivotTable at the specified index and delete the PivotTable data
* @param {Number} index - the position index in PivotTable collection
*/
removeAt(index) {
}
/**
* Deletes the PivotTable at the specified index
* @param {Number} index - the position index in PivotTable collection
* @param {boolean} keepData - Whether to keep the PivotTable data
*/
removeAt(index, keepData) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the format defined in the PivotTable.
* @hideconstructor
*/
class PivotTableFormat {
/**
* Gets the pivot area.
*/
getPivotArea() {
}
/**
* Gets the formatted style.
* @return {Style}
*/
getStyle() {
}
/**
* Sets the style of the pivot area.
* @param {Style} style
*/
setStyle(style) {
}
}
/**
* Represents the collection of formats applied to PivotTable.
* @hideconstructor
*/
class PivotTableFormatCollection {
/**
*/
getCount() {
}
/**
* Gets the format by the index.
* @param {Number} index - The index.
* @return {PivotTableFormat}
*/
get(index) {
}
/**
* Add a PivotTableFormat.
* @return {Number} The index of new format.
*/
add() {
}
/**
* Formats selected area.
* @param {Number} axisType - PivotFieldType
* @param {Number} fieldPosition - Position of the field within the axis to which this rule applies.
* @param {Number} subtotalType - PivotFieldSubtotalType
* @param {Number} selectionType - PivotTableSelectionType
* @param {boolean} isGrandRow - Indicates whether selecting grand total rows.
* @param {boolean} isGrandColumn - Indicates whether selecting grand total columns.
* @param {Style} style - The style which appies to the area of the pivot table.
* @return {PivotTableFormat}
*/
formatArea(axisType, fieldPosition, subtotalType, selectionType, isGrandRow, isGrandColumn, style) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the options of refreshing data source of the pivot table.
*/
class PivotTableRefreshOption {
/**
* Represents the options of refreshing data source of the pivot table.
*/
constructor() {
}
/**
* Represents how to reserve missing pivot items.
* The value of the property is ReserveMissingPivotItemType integer constant.
*/
getReserveMissingPivotItemType() {
}
/**
* Represents how to reserve missing pivot items.
* The value of the property is ReserveMissingPivotItemType integer constant.
*/
setReserveMissingPivotItemType(value) {
}
}
/**
* Encapsulates the object that represents the plot area in a chart.
* @hideconstructor
*/
class PlotArea {
/**
* Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getX() {
}
/**
* Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setX(value) {
}
/**
* Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getY() {
}
/**
* Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setY(value) {
}
/**
* Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getHeight() {
}
/**
* Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setHeight(value) {
}
/**
* Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getWidth() {
}
/**
* Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setWidth(value) {
}
/**
* Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getInnerX() {
}
/**
* Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setInnerX(value) {
}
/**
* Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getInnerY() {
}
/**
* Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setInnerY(value) {
}
/**
* Gets or sets the height of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getInnerHeight() {
}
/**
* Gets or sets the height of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setInnerHeight(value) {
}
/**
* Gets or sets the width of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
getInnerWidth() {
}
/**
* Gets or sets the width of plot area in units of 1/4000 of the chart area.
* 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 InnerX, InnerY, InnerWidth and
* InnerHeight properties.For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().
*/
setInnerWidth(value) {
}
/**
* Indicates whether the plot area is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the plot area is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the area.
*/
getArea() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* Gets a Font object of the specified ChartFrame object.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Set position of the plot area to automatic
*/
setPositionAuto() {
}
}
/**
* Represents the definition of power query formula.
* @hideconstructor
*/
class PowerQueryFormula {
/**
* Gets the definition of the power query formula.
*/
getFormulaDefinition() {
}
/**
* Gets and sets the name of the power query formula.
*/
getName() {
}
/**
* Gets and sets the name of the power query formula.
*/
setName(value) {
}
/**
* Gets all items of power query formula.
*/
getPowerQueryFormulaItems() {
}
}
/**
* Represents all power query formulas in the mashup data.
* @hideconstructor
*/
class PowerQueryFormulaCollection {
/**
*/
getCount() {
}
/**
* Gets PowerQueryFormula by the index in the list.
* @param {Number} index - The index.
* @return {PowerQueryFormula}
*/
get(index) {
}
/**
* Gets PowerQueryFormula by the name of the power query formula.
* @param {String} name - The name of the item.
* @return {PowerQueryFormula}
*/
get(name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the function of power query.
* @hideconstructor
*/
class PowerQueryFormulaFunction {
/**
* Gets and sets the definition of function.
*/
getF() {
}
/**
* Gets and sets the definition of function.
*/
setF(value) {
}
/**
* Gets the definition of the power query formula.
*/
getFormulaDefinition() {
}
/**
* Gets and sets the name of the power query formula.
*/
getName() {
}
/**
* Gets and sets the name of the power query formula.
*/
setName(value) {
}
/**
* Gets all items of power query formula.
*/
getPowerQueryFormulaItems() {
}
}
/**
* Represents the item of the power query formula.
* @hideconstructor
*/
class PowerQueryFormulaItem {
/**
* Gets the name of the item.
*/
getName() {
}
/**
* Gets the value of the item.
*/
getValue() {
}
/**
* Gets the value of the item.
*/
setValue(value) {
}
}
/**
* Represents all item of the power query formula.
* @hideconstructor
*/
class PowerQueryFormulaItemCollection {
/**
*/
getCount() {
}
/**
* Gets PowerQueryFormulaItem by the index in the list.
* @param {Number} index - The index.
* @return {PowerQueryFormulaItem}
*/
get(index) {
}
/**
* Gets PowerQueryFormulaItem by the name of the item.
* @param {String} name - The name of the item.
* @return {PowerQueryFormulaItem}
*/
get(name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the parameter of power query formula.
*/
class PowerQueryFormulaParameter {
/**
*/
constructor() {
}
/**
* Gets the name of parameter.
*/
getName() {
}
/**
* Gets the name of parameter.
*/
setName(value) {
}
/**
* Gets the value of parameter.
*/
getValue() {
}
/**
* Gets the value of parameter.
*/
setValue(value) {
}
/**
* Gets the definition of the parameter.
*/
getParameterDefinition() {
}
}
/**
* Represents the parameters of power query formula.
*/
class PowerQueryFormulaParameterCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets PowerQueryFormulaParameter by the index in the list.
* @param {Number} index - The index.
* @return {PowerQueryFormulaParameter}
*/
get(index) {
}
/**
* Gets PowerQueryFormulaParameter by the name of the item.
* @param {String} name - The name of the item.
* @return {PowerQueryFormulaParameter}
*/
get(name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the pptx save options.
*/
class PptxSaveOptions {
/**
* Represents the pptx save options.
*/
constructor() {
}
/**
* Represents options of saving .pptx file.
* @param {boolean} 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_overload$1(saveAsImage) {
}
/**
* Inidicates whether ignoring hidden rows when converting Excel to PowerPoint.
*/
getIgnoreHiddenRows() {
}
/**
* Inidicates whether ignoring hidden rows when converting Excel to PowerPoint.
*/
setIgnoreHiddenRows(value) {
}
/**
* Represents what type of line needs to be adjusted size of font if height of row is small.
* The value of the property is AdjustFontSizeForRowType integer constant.
*/
getAdjustFontSizeForRowType() {
}
/**
* Represents what type of line needs to be adjusted size of font if height of row is small.
* The value of the property is AdjustFontSizeForRowType integer constant.
*/
setAdjustFontSizeForRowType(value) {
}
/**
* Gets and sets the display type when exporting to PowerPoint.
* The default exporting type is working as printing.
* The value of the property is SlideViewType integer constant.
*/
getExportViewType() {
}
/**
* Gets and sets the display type when exporting to PowerPoint.
* The default exporting type is working as printing.
* The value of the property is SlideViewType integer constant.
*/
setExportViewType(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setDefaultFont(value) {
}
/**
* 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.
* Default is true.
*/
getCheckWorkbookDefaultFont() {
}
/**
* 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.
* Default is true.
*/
setCheckWorkbookDefaultFont(value) {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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() {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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) {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
isFontSubstitutionCharGranularity() {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
setFontSubstitutionCharGranularity(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOnePagePerSheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAllColumnsInOnePagePerSheet(value) {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
getIgnoreError() {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
setIgnoreError(value) {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
getOutputBlankPageWhenNothingToPrint() {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
setOutputBlankPageWhenNothingToPrint(value) {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
getPageIndex() {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
setPageIndex(value) {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
getPageCount() {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
setPageCount(value) {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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() {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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) {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
getGridlineType() {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
setGridlineType(value) {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
getTextCrossType() {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
setTextCrossType(value) {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
getDefaultEditLanguage() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
setDefaultEditLanguage(value) {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
getSheetSet() {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
setSheetSet(value) {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
getDrawObjectEventHandler() {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
setDrawObjectEventHandler(value) {
}
/**
* Control/Indicate progress of page saving process.
*/
getPageSavingCallback() {
}
/**
* Control/Indicate progress of page saving process.
*/
setPageSavingCallback(value) {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
getEmfRenderSetting() {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
setEmfRenderSetting(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* A specified range to be allowed to edit when the sheet protection is ON.
* @hideconstructor
*/
class ProtectedRange {
/**
* Gets the Range title. This is used as a descriptor, not as a named range definition.
*/
getName() {
}
/**
* Gets the Range title. This is used as a descriptor, not as a named range definition.
*/
setName(value) {
}
/**
* Gets the CellArea object represents the cell area to be protected.
*/
getCellArea() {
}
/**
* Indicates whether the worksheets is protected with password.
*/
isProtectedWithPassword() {
}
/**
* Represents the password to protect the range.
*/
getPassword() {
}
/**
* Represents the password to protect the range.
*/
setPassword(value) {
}
/**
* The security descriptor defines user accounts who may edit this range without providing a password to access the range.
*/
getSecurityDescriptor() {
}
/**
* The security descriptor defines user accounts who may edit this range without providing a password to access the range.
*/
setSecurityDescriptor(value) {
}
/**
* Gets all referred areas.
* @return {CellArea[]} Returns all referred areas.
*/
getAreas() {
}
/**
* Adds a referred area to this
* @param {Number} startRow - The start row.
* @param {Number} startColumn - The start column.
* @param {Number} endRow - The end row.
* @param {Number} endColumn - The end column.
*/
addArea(startRow, startColumn, endRow, endColumn) {
}
}
/**
* Encapsulates a collection of ProtectedRange objects.
* @hideconstructor
*/
class ProtectedRangeCollection {
/**
*/
getCount() {
}
/**
* Gets the ProtectedRange element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {ProtectedRange} The element at the specified index.
*/
get(index) {
}
/**
* Adds a ProtectedRange item to the collection.
* @param {String} name - Range title. This is used as a descriptor, not as a named range definition.
* @param {Number} startRow - Start row index of the range.
* @param {Number} startColumn - Start column index of the range.
* @param {Number} endRow - End row index of the range.
* @param {Number} endColumn - End column index of the range.
* @return {Number} object index.
*/
add(name, startRow, startColumn, endRow, endColumn) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the various types of protection options available for a worksheet.
* @example
* //Allowing users to select locked cells of the worksheet
* worksheet.getProtection().setAllowSelectingLockedCell(true);
* //Allowing users to select unlocked cells of the worksheet
* worksheet.getProtection().setAllowSelectingUnlockedCell(true);
* @hideconstructor
*/
class Protection {
/**
* Represents if the deletion of columns is allowed on a protected worksheet.
* The columns containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled.
*/
getAllowDeletingColumn() {
}
/**
* Represents if the deletion of columns is allowed on a protected worksheet.
* The columns containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled.
*/
setAllowDeletingColumn(value) {
}
/**
* Represents if the deletion of columns is allowed on a protected worksheet.
* The columns containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead,
* please use Protection.AllowDeletingColumn property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isDeletingColumnsAllowed() {
}
/**
* Represents if the deletion of columns is allowed on a protected worksheet.
* The columns containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead,
* please use Protection.AllowDeletingColumn property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setDeletingColumnsAllowed(value) {
}
/**
* Represents if the deletion of rows is allowed on a protected worksheet.
* The rows containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled.
*/
getAllowDeletingRow() {
}
/**
* Represents if the deletion of rows is allowed on a protected worksheet.
* The rows containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled.
*/
setAllowDeletingRow(value) {
}
/**
* Represents if the deletion of rows is allowed on a protected worksheet.
* The rows containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead,
* please use Protection.AllowDeletingRow property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isDeletingRowsAllowed() {
}
/**
* Represents if the deletion of rows is allowed on a protected worksheet.
* The rows containing the cells to be deleted must be unlocked when the sheet is protected,
* and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead,
* please use Protection.AllowDeletingRow property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setDeletingRowsAllowed(value) {
}
/**
* Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
*/
getAllowFiltering() {
}
/**
* Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
*/
setAllowFiltering(value) {
}
/**
* Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFiltering property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isFilteringAllowed() {
}
/**
* Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFiltering property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setFilteringAllowed(value) {
}
/**
* Represents if the formatting of cells is allowed on a protected worksheet.
*/
getAllowFormattingCell() {
}
/**
* Represents if the formatting of cells is allowed on a protected worksheet.
*/
setAllowFormattingCell(value) {
}
/**
* Represents if the formatting of cells is allowed on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFormattingCell property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isFormattingCellsAllowed() {
}
/**
* Represents if the formatting of cells is allowed on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFormattingCell property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setFormattingCellsAllowed(value) {
}
/**
* Represents if the formatting of columns is allowed on a protected worksheet
*/
getAllowFormattingColumn() {
}
/**
* Represents if the formatting of columns is allowed on a protected worksheet
*/
setAllowFormattingColumn(value) {
}
/**
* Represents if the formatting of columns is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFormattingColumn property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isFormattingColumnsAllowed() {
}
/**
* Represents if the formatting of columns is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFormattingColumn property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setFormattingColumnsAllowed(value) {
}
/**
* Represents if the formatting of rows is allowed on a protected worksheet
*/
getAllowFormattingRow() {
}
/**
* Represents if the formatting of rows is allowed on a protected worksheet
*/
setAllowFormattingRow(value) {
}
/**
* Represents if the formatting of rows is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFormattingRow property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isFormattingRowsAllowed() {
}
/**
* Represents if the formatting of rows is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowFormattingRow property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setFormattingRowsAllowed(value) {
}
/**
* Represents if the insertion of columns is allowed on a protected worksheet
*/
getAllowInsertingColumn() {
}
/**
* Represents if the insertion of columns is allowed on a protected worksheet
*/
setAllowInsertingColumn(value) {
}
/**
* Represents if the insertion of columns is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowInsertingColumn property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isInsertingColumnsAllowed() {
}
/**
* Represents if the insertion of columns is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowInsertingColumn property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setInsertingColumnsAllowed(value) {
}
/**
* Represents if the insertion of hyperlinks is allowed on a protected worksheet
*/
getAllowInsertingHyperlink() {
}
/**
* Represents if the insertion of hyperlinks is allowed on a protected worksheet
*/
setAllowInsertingHyperlink(value) {
}
/**
* Represents if the insertion of hyperlinks is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowInsertingHyperlink property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isInsertingHyperlinksAllowed() {
}
/**
* Represents if the insertion of hyperlinks is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowInsertingHyperlink property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setInsertingHyperlinksAllowed(value) {
}
/**
* Represents if the insertion of rows is allowed on a protected worksheet
*/
getAllowInsertingRow() {
}
/**
* Represents if the insertion of rows is allowed on a protected worksheet
*/
setAllowInsertingRow(value) {
}
/**
* Represents if the insertion of rows is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowInsertingRow property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isInsertingRowsAllowed() {
}
/**
* Represents if the insertion of rows is allowed on a protected worksheet
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowInsertingRow property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setInsertingRowsAllowed(value) {
}
/**
* Represents if the sorting option is allowed on a protected worksheet.
*/
getAllowSorting() {
}
/**
* Represents if the sorting option is allowed on a protected worksheet.
*/
setAllowSorting(value) {
}
/**
* Represents if the sorting option is allowed on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowSorting property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isSortingAllowed() {
}
/**
* Represents if the sorting option is allowed on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowSorting property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSortingAllowed(value) {
}
/**
* Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
*/
getAllowUsingPivotTable() {
}
/**
* Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
*/
setAllowUsingPivotTable(value) {
}
/**
* Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowUsingPivotTable property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isUsingPivotTablesAllowed() {
}
/**
* Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowUsingPivotTable property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setUsingPivotTablesAllowed(value) {
}
/**
* Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
*/
getAllowEditingContent() {
}
/**
* Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
*/
setAllowEditingContent(value) {
}
/**
* Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowEditingContent property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isEditingContentsAllowed() {
}
/**
* Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowEditingContent property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEditingContentsAllowed(value) {
}
/**
* Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
*/
getAllowEditingObject() {
}
/**
* Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
*/
setAllowEditingObject(value) {
}
/**
* Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowEditingObject property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isEditingObjectsAllowed() {
}
/**
* Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowEditingObject property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEditingObjectsAllowed(value) {
}
/**
* Represents if the user is allowed to edit scenarios on a protected worksheet.
*/
getAllowEditingScenario() {
}
/**
* Represents if the user is allowed to edit scenarios on a protected worksheet.
*/
setAllowEditingScenario(value) {
}
/**
* Represents if the user is allowed to edit scenarios on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowEditingScenario property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isEditingScenariosAllowed() {
}
/**
* Represents if the user is allowed to edit scenarios on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowEditingScenario property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEditingScenariosAllowed(value) {
}
/**
* Represents the password to protect the worksheet.
* If password is set to null or blank string, you can unprotect the worksheet or workbook without using a password. Otherwise, you must specify the password to unprotect the worksheet or workbook.
*/
getPassword() {
}
/**
* Represents the password to protect the worksheet.
* If password is set to null or blank string, you can unprotect the worksheet or workbook without using a password. Otherwise, you must specify the password to unprotect the worksheet or workbook.
*/
setPassword(value) {
}
/**
* Indicates whether the worksheets is protected with password.
*/
isProtectedWithPassword() {
}
/**
* Represents if the user is allowed to select locked cells on a protected worksheet.
*/
getAllowSelectingLockedCell() {
}
/**
* Represents if the user is allowed to select locked cells on a protected worksheet.
*/
setAllowSelectingLockedCell(value) {
}
/**
* Represents if the user is allowed to select locked cells on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowSelectingLockedCell property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isSelectingLockedCellsAllowed() {
}
/**
* Represents if the user is allowed to select locked cells on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowSelectingLockedCell property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSelectingLockedCellsAllowed(value) {
}
/**
* Represents if the user is allowed to select unlocked cells on a protected worksheet.
*/
getAllowSelectingUnlockedCell() {
}
/**
* Represents if the user is allowed to select unlocked cells on a protected worksheet.
*/
setAllowSelectingUnlockedCell(value) {
}
/**
* Represents if the user is allowed to select unlocked cells on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowSelectingUnlockedCell property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isSelectingUnlockedCellsAllowed() {
}
/**
* Represents if the user is allowed to select unlocked cells on a protected worksheet.
* NOTE: This member is now obsolete. Instead,
* please use Protection.AllowSelectingUnlockedCell property.
* This property will be removed 12 months later since June 2010.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSelectingUnlockedCellsAllowed(value) {
}
/**
* Copy protection info.
* @param {Protection} source
*/
copy(source) {
}
/**
* Gets the hash of current password.
*/
getPasswordHash() {
}
/**
* Verifies password.
* @param {String} password - The password.
* @return {boolean}
*/
verifyPassword(password) {
}
}
/**
* Represents QueryTable information.
* @hideconstructor
*/
class QueryTable {
/**
* Gets the connection id of the query table.
*/
getConnectionId() {
}
/**
* Gets the relate external connection.
*/
getExternalConnection() {
}
/**
* Gets the name of querytable.
*/
getName() {
}
/**
* Gets the range of the result.
* @return {Range}
*/
getResultRange() {
}
/**
* Returns or sets the PreserveFormatting of the object.
*/
getPreserveFormatting() {
}
/**
* Returns or sets the PreserveFormatting of the object.
*/
setPreserveFormatting(value) {
}
/**
* Returns or sets the AdjustColumnWidth of the object.
*/
getAdjustColumnWidth() {
}
/**
* Returns or sets the AdjustColumnWidth of the object.
*/
setAdjustColumnWidth(value) {
}
}
/**
* A collection of QueryTableCollection objects that represent QueryTable collection information.
* @hideconstructor
*/
class QueryTableCollection {
/**
*/
getCount() {
}
/**
* Gets the querytable by the specific index.
* @param {Number} index - The index.
* @return {QueryTable} The querytable
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* This class specifies the radical equation, consisting of an optional degree deg(EquationNodeType.Degree) and a base.
* @hideconstructor
*/
class RadicalEquationNode {
/**
* Whether to hide the degree of radicals.
*/
isDegHide() {
}
/**
* Whether to hide the degree of radicals.
*/
setDegHide(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents a radio button.
* @hideconstructor
*/
class RadioButton {
/**
* Indicates if the radiobutton is checked or not.
*/
isChecked() {
}
/**
* Indicates if the radiobutton is checked or not.
*/
setChecked(value) {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
getShadow() {
}
/**
* Indicates whether the combobox has 3-D shading.
*/
setShadow(value) {
}
/**
* Gets the GroupBox that contains this RadioButton.
*/
getGroupBox() {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the option index (one-based) in all the radio buttons of the GroupBox which contains this radio button.
* If this radio button is not in the GroupBox, returns the option index in all radio buttons that are not in any GroupBox
* @return {Number}
*/
getOptionIndex() {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a RadioButton ActiveX control.
* @hideconstructor
*/
class RadioButtonActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and sets the group's name.
*/
getGroupName() {
}
/**
* Gets and sets the group's name.
*/
setGroupName(value) {
}
/**
* Gets and set the position of the Caption relative to the control.
* The value of the property is ControlCaptionAlignmentType integer constant.
*/
getAlignment() {
}
/**
* Gets and set the position of the Caption relative to the control.
* The value of the property is ControlCaptionAlignmentType integer constant.
*/
setAlignment(value) {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
isWordWrapped() {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
setWordWrapped(value) {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
getCaption() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
setCaption(value) {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
getPicturePosition() {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
setPicturePosition(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Gets and sets the data of the picture.
*/
getPicture() {
}
/**
* Gets and sets the data of the picture.
*/
setPicture(value) {
}
/**
* Gets and sets the accelerator key for the control.
*/
getAccelerator() {
}
/**
* Gets and sets the accelerator key for the control.
*/
setAccelerator(value) {
}
/**
* Indicates if the control is checked or not.
* The value of the property is CheckValueType integer constant.
*/
getValue() {
}
/**
* Indicates if the control is checked or not.
* The value of the property is CheckValueType integer constant.
*/
setValue(value) {
}
/**
* Indicates how the specified control will display Null values.
* SettingDescriptionTrueThe 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() {
}
/**
* Indicates how the specified control will display Null values.
* SettingDescriptionTrueThe 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.
*/
setTripleState(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Encapsulates the object that represents a range of cells within a spreadsheet.
* 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.
* @hideconstructor
*/
class 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.
*/
getCurrentRegion() {
}
/**
* Gets all hyperlink in the range.
*/
getHyperlinks() {
}
/**
* Gets the count of rows in the range.
*/
getRowCount() {
}
/**
* Gets the count of columns in the range.
*/
getColumnCount() {
}
/**
* Gets or sets the name of the range.
* Named range is supported. For example,
* range.Name = "Sheet1!MyRange";
*/
getName() {
}
/**
* Gets or sets the name of the range.
* Named range is supported. For example,
* range.Name = "Sheet1!MyRange";
*/
setName(value) {
}
/**
* Gets the range's refers to.
*/
getRefersTo() {
}
/**
* Gets address of the range.
*/
getAddress() {
}
/**
* Gets the distance, in points, from the left edge of column A to the left edge of the range.
*/
getLeft() {
}
/**
* Gets the distance, in points, from the top edge of row 1 to the top edge of the range.
*/
getTop() {
}
/**
* Gets the width of a range in points.
*/
getWidth() {
}
/**
* Gets the width of a range in points.
*/
getHeight() {
}
/**
* Gets the index of the first row of the range.
*/
getFirstRow() {
}
/**
* Gets the index of the first column of the range.
*/
getFirstColumn() {
}
/**
* Gets and sets the value of the range.
* If the range contains multiple cells, the returned/applied object should be Object[][].
*/
getValue() {
}
/**
* Gets and sets the value of the range.
* If the range contains multiple cells, the returned/applied object should be Object[][].
*/
setValue(value) {
}
/**
* Sets or gets the column width of this range
*/
getColumnWidth() {
}
/**
* Sets or gets the column width of this range
*/
setColumnWidth(value) {
}
/**
* Sets or gets the height of rows in this range
*/
getRowHeight() {
}
/**
* Sets or gets the height of rows in this range
*/
setRowHeight(value) {
}
/**
* Gets a Range object that represents the entire column (or columns) that contains the specified range.
*/
getEntireColumn() {
}
/**
* Gets a Range object that represents the entire row (or rows) that contains the specified range.
*/
getEntireRow() {
}
/**
* Gets the Worksheetobject which contains this range.
*/
getWorksheet() {
}
/**
* Gets Cell object in this range.
* @param {Number} rowOffset - Row offset in this range, zero based.
* @param {Number} columnOffset - Column offset in this range, zero based.
* @return {Cell} Cell object.
*/
get(rowOffset, columnOffset) {
}
/**
* Automaticall fill the target range.
* @param {Range} target - the target range.
*/
autoFill(target) {
}
/**
* Automaticall fill the target range.
* @param {Range} target - The targed range.
* @param {Number} autoFillType - AutoFillType
*/
autoFill(target, autoFillType) {
}
/**
* Adds a hyperlink to a specified cell or a range of cells.
* @param {String} address - Address of the hyperlink.
* @param {String} textToDisplay - The text to be displayed for the specified hyperlink.
* @param {String} screenTip - The screenTip text for the specified hyperlink.
* @return {Hyperlink} Hyperlink object.
*/
addHyperlink(address, textToDisplay, screenTip) {
}
/**
* Gets the enumerator for cells in this Range.
* 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).@return {Iterator} The cells enumerator
*/
iterator() {
}
/**
* Indicates whether the range is intersect.
* If the two ranges area not in the same worksheet ,return false.
* @param {Range} range - The range.
* @return {boolean} Whether the range is intersect.
*/
isIntersect(range) {
}
/**
* Returns a Range object that represents the rectangular intersection of two ranges.
* If the two ranges are not intersected, returns null.
* @param {Range} range - The intersecting range.
* @return {Range} Returns a Range object
*/
intersect(range) {
}
/**
* Returns the union result of two ranges.
* @param {Range} range - The range
* @return {Range[]} The union of two ranges.
*/
unionRang(range) {
}
/**
* Returns the union of two ranges.
* NOTE: This method is now obsolete. Instead,
* please use Range.UnionRang() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Range} range - The range
* @return {ArrayList} The union of two ranges.
*/
union(range) {
}
/**
* Indicates whether the range contains values.
* @return {boolean}
*/
isBlank() {
}
/**
* Combines a range of cells into a single cell.
* Reference the merged cell via the address of the upper-left cell in the range.
*/
merge() {
}
/**
* Unmerges merged cells of this range.
*/
unMerge() {
}
/**
* 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 {String} stringValue - Input value
* @param {boolean} isConverted - True: converted to other data type if appropriate.
* @param {boolean} setStyle - True: set the number format to cell's style when converting to other data type
*/
putValue(stringValue, isConverted, setStyle) {
}
/**
* Apply the cell style.
* @param {Style} style - The cell style.
* @param {boolean} explicitFlag - True, only overwriting formatting which is explicitly set.
*/
setStyle(style, explicitFlag) {
}
/**
* Applies formats for a whole range.
* Each cell in this range will contains a Style object.
* So this is a memory-consuming method. Please use it carefully.
* @param {Style} style - The style object which will be applied.
* @param {StyleFlag} flag - Flags which indicates applied formatting properties.
*/
applyStyle(style, flag) {
}
/**
* Sets the style of the range.
* @param {Style} style - The Style object.
*/
setStyle(style) {
}
/**
* Sets the outline borders around a range of cells with same border style and color.
* @param {Number} borderStyle - CellBorderType
* @param {CellsColor} borderColor - Border color.
*/
setOutlineBorders(borderStyle, borderColor) {
}
/**
* Sets the outline borders around a range of cells with same border style and color.
* @param {Number} borderStyle - CellBorderType
* @param {Color} borderColor - Border color.
*/
setOutlineBorders(borderStyle, borderColor) {
}
/**
* Sets out line borders around a range of cells.
* Both the length of borderStyles and borderStyles must be 4.
* The order of borderStyles and borderStyles must be top,bottom,left,right
* @param {Number[]} borderStyles - Border styles.
* @param {Color[]} borderColors - Border colors.
*/
setOutlineBorders(borderStyles, borderColors) {
}
/**
* Sets outline border around a range of cells.
* @param {Number} borderEdge - BorderType
* @param {Number} borderStyle - CellBorderType
* @param {CellsColor} borderColor - Border color.
*/
setOutlineBorder(borderEdge, borderStyle, borderColor) {
}
/**
* Sets outline border around a range of cells.
* @param {Number} borderEdge - BorderType
* @param {Number} borderStyle - CellBorderType
* @param {Color} borderColor - Border color.
*/
setOutlineBorder(borderEdge, borderStyle, borderColor) {
}
/**
* Set inside borders of the range.
* @param {Number} borderEdge - BorderType
* @param {Number} lineStyle - CellBorderType
* @param {CellsColor} borderColor - The color of the border.
*/
setInsideBorders(borderEdge, lineStyle, borderColor) {
}
/**
* Move the current range to the dest range.
* @param {Number} destRow - The start row of the dest range.
* @param {Number} destColumn - The start column of the dest range.
*/
moveTo(destRow, destColumn) {
}
/**
* Copies cell data (including formulas) from a source range.
* @param {Range} range - Source
*/
copyData(range) {
}
/**
* Copies cell value from a source range.
* @param {Range} range - Source
*/
copyValue(range) {
}
/**
* Copies style settings from a source range.
* @param {Range} range - Source
*/
copyStyle(range) {
}
/**
* Copying the range with paste special options.
* @param {Range} range - The source range.
* @param {PasteOptions} options - The paste special options.
*/
copy(range, options) {
}
/**
* Copies data (including formulas), formatting, drawing objects etc. from a source range.
* @param {Range} range - Source
*/
copy(range) {
}
/**
* Gets Cell object or null in this range.
* @param {Number} rowOffset - Row offset in this range, zero based.
* @param {Number} columnOffset - Column offset in this range, zero based.
* @return {Cell} Cell object.
*/
getCellOrNull(rowOffset, columnOffset) {
}
/**
* Gets Range range by offset.
* @param {Number} rowOffset - Row offset in this range, zero based.
* @param {Number} columnOffset - Column offset in this range, zero based.
* @return {Range}
*/
getOffset(rowOffset, columnOffset) {
}
/**
* Returns a string represents the current Range object.
* @return {String}
*/
toString() {
}
}
/**
* Encapsulates a collection of Range objects.
* @hideconstructor
*/
class RangeCollection {
/**
*/
getCount() {
}
/**
* Gets the Range element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Range} The element at the specified index.
*/
get(index) {
}
/**
* Adds a Range item to the collection.
* @param {Range} range - Range object
* @return {Number}
*/
add(range) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the rectangle shape.
* @hideconstructor
*/
class RectangleShape {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a referred area by the formula.
* @hideconstructor
*/
class ReferredArea {
/**
* Indicates whether this is an external link.
*/
isExternalLink() {
}
/**
* Get the external file name if this is an external reference.
*/
getExternalFileName() {
}
/**
* Indicates which sheet this reference is in.
*/
getSheetName() {
}
/**
* Indicates whether this is an area.
* If this is not an area, only StartRow and StartColumn effect.
*/
isArea() {
}
/**
* The end column of the area.
*/
getEndColumn() {
}
/**
* The start column of the area.
*/
getStartColumn() {
}
/**
* The end row of the area.
*/
getEndRow() {
}
/**
* The start row of the area.
*/
getStartRow() {
}
/**
* Gets cell values in this area.
* @return {Object} If this area is invalid, "#REF!" will be returned;
* If this area is one single cell, then return the cell value object;
* Otherwise return one 2D array for all values in this area.
*/
getValues() {
}
/**
* Gets cell values in this area.
* @param {boolean} calculateFormulas - In this range, if there are some formulas that have not been calculated,
* this flag denotes whether those formulas should be calculated recursively
* @return {Object} If this area is invalid, "#REF!" will be returned;
* If this area is one single cell, then return the cell value object;
* Otherwise return one 2D array for all values in this area.
*/
getValues(calculateFormulas) {
}
/**
* Gets cell value with given offset from the top-left of this area.
* @param {Number} rowOffset - row offset from the start row of this area
* @param {Number} colOffset - column offset from the start row of this area
* @return {Object} "#REF!" if this area is invalid;
* "#N/A" if given offset out of this area;
* Otherwise return the cell value at given position.
*/
getValue(rowOffset, colOffset) {
}
/**
* Gets cell value with given offset from the top-left of this area.
* @param {Number} rowOffset - row offset from the start row of this area
* @param {Number} colOffset - column offset from the start row of this area
* @param {boolean} calculateFormulas - Whether calculate it recursively if the specified reference is formula
* @return {Object} "#REF!" if this area is invalid;
* "#N/A" if given offset out of this area;
* Otherwise return the cell value at given position.
*/
getValue(rowOffset, colOffset, calculateFormulas) {
}
/**
* Returns the simple string representation of this area.
* @return {String}
*/
toString() {
}
}
/**
* Represents all referred cells and areas.
* @hideconstructor
*/
class ReferredAreaCollection {
/**
*/
getCount() {
}
/**
* @param {Number} index
* @return {ReferredArea}
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* This class specifies a reflection effect.
* @hideconstructor
*/
class ReflectionEffect {
/**
* Gets and sets the preset reflection effect.
* The value of the property is ReflectionEffectType integer constant.
*/
getType() {
}
/**
* Gets and sets the preset reflection effect.
* The value of the property is ReflectionEffectType integer constant.
*/
setType(value) {
}
/**
* Gets and sets the degree of the starting reflection transparency as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Gets and sets the degree of the starting reflection transparency as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets and sets the end position (along the alpha gradient ramp) of the end alpha value,in unit of percentage
*/
getSize() {
}
/**
* Gets and sets the end position (along the alpha gradient ramp) of the end alpha value,in unit of percentage
*/
setSize(value) {
}
/**
* Gets and sets the blur radius,in unit of points.
*/
getBlur() {
}
/**
* Gets and sets the blur radius,in unit of points.
*/
setBlur(value) {
}
/**
* Gets and sets the direction of the alpha gradient ramp relative to the shape itself.
*/
getDirection() {
}
/**
* Gets and sets the direction of the alpha gradient ramp relative to the shape itself.
*/
setDirection(value) {
}
/**
* Gets and sets how far to distance the shadow,in unit of points.
*/
getDistance() {
}
/**
* Gets and sets how far to distance the shadow,in unit of points.
*/
setDistance(value) {
}
/**
* Gets and sets the direction to offset the reflection.
*/
getFadeDirection() {
}
/**
* Gets and sets the direction to offset the reflection.
*/
setFadeDirection(value) {
}
/**
* Gets and sets if the reflection should rotate with the shape.
*/
getRotWithShape() {
}
/**
* Gets and sets if the reflection should rotate with the shape.
*/
setRotWithShape(value) {
}
}
/**
* Font for rendering.
*/
class RenderingFont {
/**
* Initializes a new instance of the RenderingFont
* @param {String} fontName - font name
* @param {Number} fontSize - font size in points
*/
constructor(fontName, fontSize) {
}
/**
* Gets name of the font.
*/
getName() {
}
/**
* Gets size of the font in points.
*/
getSize() {
}
/**
* Gets or sets bold for the font.
*/
getBold() {
}
/**
* Gets or sets bold for the font.
*/
setBold(value) {
}
/**
* Gets or sets italic for the font.
*/
getItalic() {
}
/**
* Gets or sets italic for the font.
*/
setItalic(value) {
}
/**
* Gets or sets color for the font.
*/
getColor() {
}
/**
* Gets or sets color for the font.
*/
setColor(value) {
}
}
/**
* Watermark for rendering.
*/
class RenderingWatermark {
/**
* Creates instance of text watermark.
* @param {String} text - watermark text
* @param {RenderingFont} renderingFont - watermark font
*/
constructor(text, renderingFont) {
}
/**
* Creates instance of image watermark.
* @param {byte[]} imageData
*/
constructor_overload$1(imageData) {
}
/**
* Gets or sets roation of the watermark in degrees.
*/
getRotation() {
}
/**
* Gets or sets roation of the watermark in degrees.
*/
setRotation(value) {
}
/**
* Gets or sets scale relative to target page in percent.
*/
getScaleToPagePercent() {
}
/**
* Gets or sets scale relative to target page in percent.
*/
setScaleToPagePercent(value) {
}
/**
* Gets or sets opacity of the watermark in range [0, 1].
*/
getOpacity() {
}
/**
* Gets or sets opacity of the watermark in range [0, 1].
*/
setOpacity(value) {
}
/**
* Indicates whether the watermark is placed behind page contents.
*/
isBackground() {
}
/**
* Indicates whether the watermark is placed behind page contents.
*/
setBackground(value) {
}
/**
* Gets text of the watermark.
*/
getText() {
}
/**
* Gets font of the watermark.
*/
getFont() {
}
/**
* Gets image of the watermark.
*/
getImage() {
}
/**
* Gets or sets horizontal alignment of the watermark to the page.
* The value of the property is TextAlignmentType integer constant.
* Only Left, Center, Right is valid. Default is Left.
*/
getHAlignment() {
}
/**
* Gets or sets horizontal alignment of the watermark to the page.
* The value of the property is TextAlignmentType integer constant.
* Only Left, Center, Right is valid. Default is Left.
*/
setHAlignment(value) {
}
/**
* Gets or sets vertical alignment of the watermark to the page.
* The value of the property is TextAlignmentType integer constant.
* Only Top, Center, Bottom is valid. Default is Top.
*/
getVAlignment() {
}
/**
* Gets or sets vertical alignment of the watermark to the page.
* The value of the property is TextAlignmentType integer constant.
* Only Top, Center, Bottom is valid. Default is Top.
*/
setVAlignment(value) {
}
/**
* Gets or sets offset value to HAlignment
*/
getOffsetX() {
}
/**
* Gets or sets offset value to HAlignment
*/
setOffsetX(value) {
}
/**
* Gets or sets offset value to VAlignment
*/
getOffsetY() {
}
/**
* Gets or sets offset value to VAlignment
*/
setOffsetY(value) {
}
}
/**
* Represent the replace options.
*/
class ReplaceOptions {
/**
*/
constructor() {
}
/**
* Indicates if the searched string is case sensitive.
*/
getCaseSensitive() {
}
/**
* Indicates if the searched string is case sensitive.
*/
setCaseSensitive(value) {
}
/**
* Indicates whether to match entire cells contents
*/
getMatchEntireCellContents() {
}
/**
* Indicates whether to match entire cells contents
*/
setMatchEntireCellContents(value) {
}
/**
* Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
*/
getRegexKey() {
}
/**
* Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
*/
setRegexKey(value) {
}
/**
* The rich formatted settings for the replaced text.
*/
getFontSettings() {
}
/**
* The rich formatted settings for the replaced text.
*/
setFontSettings(value) {
}
}
/**
* Represents the revision.
* @hideconstructor
*/
class Revision {
/**
* Represents the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* represents a revision record of information about a formatting change.
* @hideconstructor
*/
class RevisionAutoFormat {
/**
* Gets the type of the revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the location where the formatting was applied.
*/
getCellArea() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents the revision that changing cells.
* @hideconstructor
*/
class RevisionCellChange {
/**
* Represents the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the name of the cell.
*/
getCellName() {
}
/**
* Gets the row index of the cell.
*/
getRow() {
}
/**
* Gets the column index of the cell.
*/
getColumn() {
}
/**
* Indicates whether this cell is new formatted.
*/
isNewFormatted() {
}
/**
* Indicates whether this cell is old formatted.
*/
isOldFormatted() {
}
/**
* Gets the old formula.
*/
getOldFormula() {
}
/**
* Gets old value of the cell.
*/
getOldValue() {
}
/**
* Gets new value of the cell.
*/
getNewValue() {
}
/**
* Gets the old formula.
*/
getNewFormula() {
}
/**
* Gets the new style of the cell.
*/
getNewStyle() {
}
/**
* Gets the old style of the cell.
*/
getOldStyle() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a revision record of a cell comment change.
* @hideconstructor
*/
class RevisionCellComment {
/**
* Gets the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the row index of the which contains a comment.
*/
getRow() {
}
/**
* Gets the column index of the which contains a comment.
*/
getColumn() {
}
/**
* Gets the name of the cell.
*/
getCellName() {
}
/**
* Gets the name of the cell.
*/
setCellName(value) {
}
/**
* Gets the action type of the revision.
* The value of the property is RevisionActionType integer constant.
*/
getActionType() {
}
/**
* Indicates whether it's an old comment.
*/
isOldComment() {
}
/**
* Gets Length of the comment text added in this revision.
*/
getOldLength() {
}
/**
* Gets Length of the comment before this revision was made.
*/
getNewLength() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a revision record on a cell(s) that moved.
* @hideconstructor
*/
class RevisionCellMove {
/**
* Represents the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the source area.
*/
getSourceArea() {
}
/**
* Gets the destination area.
*/
getDestinationArea() {
}
/**
* Gets the source worksheet.
*/
getSourceWorksheet() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents all revision logs.
* @hideconstructor
*/
class RevisionCollection {
/**
*/
getCount() {
}
/**
* Gets Revision by the index.
* @param {Number} index
* @return {Revision}
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a revision record of adding or removing a custom view to the workbook
* @hideconstructor
*/
class RevisionCustomView {
/**
* Gets the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the type of action.
* The value of the property is RevisionActionType integer constant.
*/
getActionType() {
}
/**
* Gets the globally unique identifier of the custom view.
*/
getGuid() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a revision record of a defined name change.
* @hideconstructor
*/
class RevisionDefinedName {
/**
* Represents the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the text of the defined name.
*/
getText() {
}
/**
* Gets the old formula.
*/
getOldFormula() {
}
/**
* Gets the formula.
*/
getNewFormula() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a revision record of information about a formatting change.
* @hideconstructor
*/
class RevisionFormat {
/**
* Gets the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* The range to which this formatting was applied.
*/
getAreas() {
}
/**
* Gets the applied style.
*/
getStyle() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a list of specific changes that have taken place for this workbook.
*/
class RevisionHeader {
/**
*/
constructor() {
}
/**
* Gets and sets rhe date and time when this set of revisions was saved.
*/
getSavedTime() {
}
/**
* Gets and sets rhe date and time when this set of revisions was saved.
*/
setSavedTime(value) {
}
/**
* Gets and sets the name of the user making the revision.
*/
getUserName() {
}
/**
* Gets and sets the name of the user making the revision.
*/
setUserName(value) {
}
}
/**
* Represents a revision record of a row/column insert/delete action.
* @hideconstructor
*/
class RevisionInsertDelete {
/**
* Represents the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the inserting/deleting range.
*/
getCellArea() {
}
/**
* Gets the action type of this revision.
* The value of the property is RevisionActionType integer constant.
*/
getActionType() {
}
/**
* Gets revision list by this operation.
*/
getRevisions() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a revision record of a sheet that was inserted.
* @hideconstructor
*/
class RevisionInsertSheet {
/**
* Gets the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the action type of the revision.
* The value of the property is RevisionActionType integer constant.
*/
getActionType() {
}
/**
* Gets the name of the worksheet.
*/
getName() {
}
/**
* Gets the zero based position of the new sheet in the sheet tab bar.
*/
getSheetPosition() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents the revision log.
* @hideconstructor
*/
class RevisionLog {
/**
* Gets table that contains metadata about a list of specific changes that have taken place
* for this workbook.
*/
getMetadataTable() {
}
/**
* Gets all revisions in this log.
*/
getRevisions() {
}
}
/**
* Represents all revision logs.
* @hideconstructor
*/
class RevisionLogCollection {
/**
* Gets and sets the number of days the spreadsheet application will keep the change history for this workbook.
*/
getDaysPreservingHistory() {
}
/**
* Gets and sets the number of days the spreadsheet application will keep the change history for this workbook.
*/
setDaysPreservingHistory(value) {
}
/**
*/
getCount() {
}
/**
* Gets RevisionLog by index.
* @param {Number} index - The index.
* @return {RevisionLog} Returns RevisionLog object.
*/
get(index) {
}
/**
* Highlights changes of shared workbook.
* @param {HighlightChangesOptions} options - Set the options for filtering which changes should be tracked.
*/
highlightChanges(options) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a revision record which indicates that there was a merge conflict.
* @hideconstructor
*/
class RevisionMergeConflict {
/**
* Gets the type of revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a revision of a query table field change.
* @hideconstructor
*/
class RevisionQueryTable {
/**
* Represents the type of the revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the location of the affected query table.
*/
getCellArea() {
}
/**
* Gets ID of the specific query table field that was removed.
*/
getFieldId() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a revision of renaming sheet.
* @hideconstructor
*/
class RevisionRenameSheet {
/**
* Represents the type of the revision.
* The value of the property is RevisionType integer constant.
*/
getType() {
}
/**
* Gets the old name of the worksheet.
*/
getOldName() {
}
/**
* Gets the new name of the worksheet.
*/
getNewName() {
}
/**
* Gets the worksheet.
*/
getWorksheet() {
}
/**
* Gets the number of this revision.
* Zero means this revision does not contains id.
*/
getId() {
}
}
/**
* Represents a single row in a worksheet.
* @hideconstructor
*/
class Row {
/**
* Indicates whether the row contains any data
*/
isBlank() {
}
/**
* whether the row is collapsed
*/
isCollapsed() {
}
/**
* whether the row is collapsed
*/
setCollapsed(value) {
}
/**
* Gets and sets the row height in unit of Points.
*/
getHeight() {
}
/**
* Gets and sets the row height in unit of Points.
*/
setHeight(value) {
}
/**
* Indicates whether the row is hidden.
*/
isHidden() {
}
/**
* Indicates whether the row is hidden.
*/
setHidden(value) {
}
/**
* Gets the index of this row.
*/
getIndex() {
}
/**
* Gets the group level of the row.
*/
getGroupLevel() {
}
/**
* Gets the group level of the row.
*/
setGroupLevel(value) {
}
/**
* 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.
* When this property is true, if the content in this row changes,
* generally the row height needs to be re-calculated(such as by Worksheet.autoFitRows())
* to get the same result with what is shown in ms excel when you opening the workbook in it.
*/
isHeightMatched() {
}
/**
* 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.
* When this property is true, if the content in this row changes,
* generally the row height needs to be re-calculated(such as by Worksheet.autoFitRows())
* to get the same result with what is shown in ms excel when you opening the workbook in it.
*/
setHeightMatched(value) {
}
/**
* Indicates whether this row has custom style settings(different from the default one inherited from workbook).
*/
hasCustomStyle() {
}
/**
* Gets the first cell object in the row.
*/
getFirstCell() {
}
/**
* Gets the first non-blank cell in the row.
*/
getFirstDataCell() {
}
/**
* Gets the last cell object in the row.
*/
getLastCell() {
}
/**
* Gets the last non-blank cell in the row.
*/
getLastDataCell() {
}
/**
* Gets the cell.
* @param {Number} column - The column index
* @return {Cell}
*/
get(column) {
}
/**
* Get the cell by specific index in the cells collection of this row.
* To traverse all cells in sequence without modification,
* using iterator() will give better performance than using this method to get cell one by one.
* @param {Number} index - The index(position) of the cell in the cells collection of this row.
* @return {Cell} The Cell object at given position.
*/
getCellByIndex(index) {
}
/**
* Gets the cells enumerator
* @return {Iterator} The cells enumerator
*/
iterator() {
}
/**
* Gets the cell or null in the specific index.
* @param {Number} column - The column index
* @return {Cell} Returns the cell object if the cell exists.
* Or returns null if the cell object does not exist.
*/
getCellOrNull(column) {
}
/**
* Gets the style of this row.
* Modifying the returned style object directly takes no effect for this row or any cells in this row.
* You have to call applyStyle(com.aspose.cells.Style, com.aspose.cells.StyleFlag) or setStyle(com.aspose.cells.Style) 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() {
}
/**
* Sets the style of this row.
* 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 applyStyle(com.aspose.cells.Style, com.aspose.cells.StyleFlag)
* @param {Style} style - the style to be used as the default style for cells in this row.
*/
setStyle(style) {
}
/**
* Copy settings of row, such as style, height, visibility, ...etc.
* @param {Row} source - the source row whose settings will be copied to this one
* @param {boolean} 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, checkStyle) {
}
/**
* Applies formats for a whole row.
* @param {Style} style - The style object which will be applied.
* @param {StyleFlag} flag - Flags which indicates applied formatting properties.
*/
applyStyle(style, flag) {
}
/**
* Checks whether this object refers to the same row with another.
* @param {Object} obj - another object
* @return {boolean} true if two objects refers to the same row.
*/
equals(obj) {
}
/**
* Checks whether this object refers to the same row with another row object.
* @param {Row} row - another row object
* @return {boolean} true if two row objects refers to the same row.
*/
equals(row) {
}
}
/**
* Collects the Row objects that represent the individual rows in a worksheet.
* @hideconstructor
*/
class RowCollection {
/**
* Gets the number of rows in this collection.
*/
getCount() {
}
/**
* Gets a Row object by given row index. The Row object of given row index will be instantiated if it does not exist before.
*/
get(rowIndex) {
}
/**
* Gets an enumerator that iterates rows through this collection
* @return {Iterator} enumerator
*/
iterator() {
}
/**
* Gets the row object by the position in the list.
* @param {Number} index - The position.
* @return {Row} The Row object at given position.
*/
getRowByIndex(index) {
}
/**
* Clear all rows and cells.
*/
clear() {
}
/**
* Remove the row item at the specified index(position) in this collection.
* @param {Number} index - zero-based index(position, not
*/
removeAt(index) {
}
}
/**
* Represents all save options
* @hideconstructor
*/
class SaveOptions {
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents an individual scenario.
* @hideconstructor
*/
class Scenario {
/**
* Gets and sets the comment of scenario.
*/
getComment() {
}
/**
* Gets and sets the comment of scenario.
*/
setComment(value) {
}
/**
* Gets and sets the name of scenario.
*/
getName() {
}
/**
* Gets and sets the name of scenario.
*/
setName(value) {
}
/**
* Gets name of user who last changed the scenario.
*/
getUser() {
}
/**
* Indicates whether scenario is hidden.
*/
isHidden() {
}
/**
* Indicates whether scenario is hidden.
*/
setHidden(value) {
}
/**
* Indicates whether scenario is locked for editing when the sheet is protected.
*/
isLocked() {
}
/**
* Indicates whether scenario is locked for editing when the sheet is protected.
*/
setLocked(value) {
}
/**
* Gets the input cells of scenario.
*/
getInputCells() {
}
}
/**
* Represents the list of scenarios.
* @hideconstructor
*/
class ScenarioCollection {
/**
* Gets and sets which scenario is selected.
*/
getActiveIndex() {
}
/**
* Gets and sets which scenario is selected.
*/
setActiveIndex(value) {
}
/**
* Indicates which scenario was last selected by the user to be run/shown.
*/
getLastSelected() {
}
/**
* Indicates which scenario was last selected by the user to be run/shown.
*/
setLastSelected(value) {
}
/**
*/
getCount() {
}
/**
* Gets the Scenario object by the index.
* @param {Number} index - The specific index in the list.
* @return {Scenario}
*/
get(index) {
}
/**
* Adds a scenario.
* @param {String} name - The name of scenario.
* @return {Number} The index in the list of scenarios.
*/
add(name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents input cell for the scenario.
* @hideconstructor
*/
class ScenarioInputCell {
/**
* Gets and sets the row index of the input cell.
*/
getRow() {
}
/**
* Gets and sets the column index of the input cell.
*/
getColumn() {
}
/**
* Gets and sets the input cell address.
*/
getName() {
}
/**
* Gets and sets value of the input cell.
*/
getValue() {
}
/**
* Gets and sets value of the input cell.
*/
setValue(value) {
}
/**
* Indicates whether input cell is deleted.
*/
isDeleted() {
}
/**
* Indicates whether input cell is deleted.
*/
setDeleted(value) {
}
}
/**
* Represents the list of the scenario's input cells.
* @hideconstructor
*/
class ScenarioInputCellCollection {
/**
*/
getCount() {
}
/**
* Gets ScenarioInputCell by index in the list.
* @param {Number} index - The specific index in the list
* @return {ScenarioInputCell} The ScenarioInputCell object
*/
get(index) {
}
/**
* Adds an input cell.
* @param {Number} row - The row index of input cell.
* @param {Number} column - The column index of input cell.
* @param {String} value - The value of input cell.
* @return {Number}
*/
add(row, column, value) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a scroll bar object.
* Scroll value must be between 0 and 30000.
* @hideconstructor
*/
class ScrollBar {
/**
* Gets or sets the current value.
*/
getCurrentValue() {
}
/**
* Gets or sets the current value.
*/
setCurrentValue(value) {
}
/**
* Gets or sets the minimum value of a scroll bar or spinner range.
*/
getMin() {
}
/**
* Gets or sets the minimum value of a scroll bar or spinner range.
*/
setMin(value) {
}
/**
* Gets or sets the maximum value of a scroll bar or spinner range.
*/
getMax() {
}
/**
* Gets or sets the maximum value of a scroll bar or spinner range.
*/
setMax(value) {
}
/**
* Gets or sets the amount that the scroll bar or spinner is incremented a line scroll.
*/
getIncrementalChange() {
}
/**
* Gets or sets the amount that the scroll bar or spinner is incremented a line scroll.
*/
setIncrementalChange(value) {
}
/**
* Gets or sets page change
*/
getPageChange() {
}
/**
* Gets or sets page change
*/
setPageChange(value) {
}
/**
* Indicates whether the shape has 3-D shading.
*/
getShadow() {
}
/**
* Indicates whether the shape has 3-D shading.
*/
setShadow(value) {
}
/**
* Indicates whether this is a horizontal scroll bar.
*/
isHorizontal() {
}
/**
* Indicates whether this is a horizontal scroll bar.
*/
setHorizontal(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents the ScrollBar control.
* @hideconstructor
*/
class ScrollBarActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and sets the amount by which the Position property changes
*/
getLargeChange() {
}
/**
* Gets and sets the amount by which the Position property changes
*/
setLargeChange(value) {
}
/**
* Gets and sets the minimum acceptable value.
*/
getMin() {
}
/**
* Gets and sets the minimum acceptable value.
*/
setMin(value) {
}
/**
* Gets and sets the maximum acceptable value.
*/
getMax() {
}
/**
* Gets and sets the maximum acceptable value.
*/
setMax(value) {
}
/**
* Gets and sets the value.
*/
getPosition() {
}
/**
* Gets and sets the value.
*/
setPosition(value) {
}
/**
* Gets and sets the amount by which the Position property changes
*/
getSmallChange() {
}
/**
* Gets and sets the amount by which the Position property changes
*/
setSmallChange(value) {
}
/**
* Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
* The value of the property is ControlScrollOrientation integer constant.
*/
getOrientation() {
}
/**
* Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
* The value of the property is ControlScrollOrientation integer constant.
*/
setOrientation(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Encapsulates the object that represents a single data series in a chart.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Excel object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "A4" cell
* worksheet.getCells().get("A4").putValue(200);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a sample value to "B4" cell
* worksheet.getCells().get("B4").putValue(40);
* //Adding a sample value to "C1" cell as category data
* worksheet.getCells().get("C1").putValue("Q1");
* //Adding a sample value to "C2" cell as category data
* worksheet.getCells().get("C2").putValue("Q2");
* //Adding a sample value to "C3" cell as category data
* worksheet.getCells().get("C3").putValue("Y1");
* //Adding a sample value to "C4" cell as category data
* worksheet.getCells().get("C4").putValue("Y2");
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
* chart.getNSeries().add("A1:B4", true);
* //Setting the data source for the category data of NSeries
* chart.getNSeries().setCategoryData("C1:C4");
* var series = chart.getNSeries().get(1);
* //Setting the values of the series.
* series.setValues("=B1:B4");
* //Changing the chart type of the series.
* series.setType(aspose.cells.ChartType.LINE);
* //Setting marker properties.
* series.getMarker().setMarkerStyle(aspose.cells.ChartMarkerType.CIRCLE);
* series.getMarker().setForegroundColorSetType(aspose.cells.FormattingType.AUTOMATIC);
* series.getMarker().setForegroundColor(aspose.cells.Color.getBlack());
* series.getMarker().setBackgroundColorSetType(aspose.cells.FormattingType.AUTOMATIC);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Series {
/**
* Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart.
*/
isFiltered() {
}
/**
* Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart.
*/
setFiltered(value) {
}
/**
* Represents the properties of layout.
*/
getLayoutProperties() {
}
/**
* Gets the collection of points in a series in a chart.
* When the chart is Pie of Pie or Bar of Pie, the last point is other point in first pie plot.
*/
getPoints() {
}
/**
* Represents the background area of Series object.
*/
getArea() {
}
/**
* Represents border of Series object.
*/
getBorder() {
}
/**
* Gets or sets the name of the data series.
* @example
* //Reference name to a cell
* chart.getNSeries().get(0).setName("=A1");
* //Set a string to name
* chart.getNSeries().get(0).setName("First Series");
*/
getName() {
}
/**
* Gets or sets the name of the data series.
* @example
* //Reference name to a cell
* chart.getNSeries().get(0).setName("=A1");
* //Set a string to name
* chart.getNSeries().get(0).setName("First Series");
*/
setName(value) {
}
/**
* Gets the series's name that displays on the chart graph.
*/
getDisplayName() {
}
/**
* Gets the number of the data values.
*/
getCountOfDataValues() {
}
/**
* Indicates whether the data source is vertical.
*/
isVerticalValues() {
}
/**
* Represents the data of the chart series.
*/
getValues() {
}
/**
* Represents the data of the chart series.
*/
setValues(value) {
}
/**
* Represents format code of Values‘s NumberList.
*/
getValuesFormatCode() {
}
/**
* Represents format code of Values‘s NumberList.
*/
setValuesFormatCode(value) {
}
/**
* Represents the x values of the chart series.
*/
getXValues() {
}
/**
* Represents the x values of the chart series.
*/
setXValues(value) {
}
/**
* Gets or sets the bubble sizes values of the chart series.
*/
getBubbleSizes() {
}
/**
* Gets or sets the bubble sizes values of the chart series.
*/
setBubbleSizes(value) {
}
/**
* Returns an object that represents a collection of all the trendlines for the series.
*/
getTrendLines() {
}
/**
* Represents curve smoothing.
* True if curve smoothing is turned on for the line chart or scatter chart.
* Applies only to line and scatter connected by lines charts.
*/
getSmooth() {
}
/**
* Represents curve smoothing.
* True if curve smoothing is turned on for the line chart or scatter chart.
* Applies only to line and scatter connected by lines charts.
*/
setSmooth(value) {
}
/**
* True if the series has a shadow.
*/
getShadow() {
}
/**
* True if the series has a shadow.
*/
setShadow(value) {
}
/**
* True if the series has a three-dimensional appearance.
* Applies only to bubble charts.
*/
getHas3DEffect() {
}
/**
* True if the series has a three-dimensional appearance.
* Applies only to bubble charts.
*/
setHas3DEffect(value) {
}
/**
* Gets or sets the 3D shape type used with the 3-D bar or column chart.
* The value of the property is Bar3DShapeType integer constant.
*/
getBar3DShapeType() {
}
/**
* Gets or sets the 3D shape type used with the 3-D bar or column chart.
* The value of the property is Bar3DShapeType integer constant.
*/
setBar3DShapeType(value) {
}
/**
* Represents the DataLabels object for the specified ASeries.
*/
getDataLabels() {
}
/**
* Gets or sets a data series' type.
* The value of the property is ChartType integer constant.
*/
getType() {
}
/**
* Gets or sets a data series' type.
* The value of the property is ChartType integer constant.
*/
setType(value) {
}
/**
* Gets the Marker.
*/
getMarker() {
}
/**
* Indicates if this series is plotted on second value axis.
*/
getPlotOnSecondAxis() {
}
/**
* Indicates if this series is plotted on second value axis.
*/
setPlotOnSecondAxis(value) {
}
/**
* Represents X direction error bar of the series.
*/
getXErrorBar() {
}
/**
* Represents Y direction error bar of the series.
*/
getYErrorBar() {
}
/**
* True if the line chart has high-low lines.
* Applies only to line charts.
*/
hasHiLoLines() {
}
/**
* True if the line chart has high-low lines.
* Applies only to line charts.
*/
setHasHiLoLines(value) {
}
/**
* Returns a HiLoLines object that represents the high-low lines for a series on a line chart.
* Applies only to line charts.
*/
getHiLoLines() {
}
/**
* True if a stacked column chart or bar chart has series lines or
* if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections.
* Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.
*/
hasSeriesLines() {
}
/**
* True if a stacked column chart or bar chart has series lines or
* if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections.
* Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.
*/
setHasSeriesLines(value) {
}
/**
* Returns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart.
* Applies only to stacked bar and stacked column charts.
*/
getSeriesLines() {
}
/**
* True if the chart has drop lines.
* Applies only to line chart or area charts.
*/
hasDropLines() {
}
/**
* True if the chart has drop lines.
* Applies only to line chart or area charts.
*/
setHasDropLines(value) {
}
/**
* Returns a Line object that represents the drop lines for a series on the line chart or area chart.
* Applies only to line chart or area charts.
*/
getDropLines() {
}
/**
* True if a line chart has up and down bars.
* Applies only to line charts.
*/
hasUpDownBars() {
}
/**
* True if a line chart has up and down bars.
* Applies only to line charts.
*/
setHasUpDownBars(value) {
}
/**
* Returns an DropBars object that represents the up bars on a line chart.
* Applies only to line charts.
*/
getUpBars() {
}
/**
* Returns a DropBars object that represents the down bars on a line chart.
* Applies only to line charts.
*/
getDownBars() {
}
/**
* Represents if the color of points is varied.
* The chart must contain only one series.
*/
isColorVaried() {
}
/**
* Represents if the color of points is varied.
* The chart must contain only one series.
*/
setColorVaried(value) {
}
/**
* Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.
* The value of this property must be between 0 and 500.
*/
getGapWidth() {
}
/**
* Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.
* The value of this property must be between 0 and 500.
*/
setGapWidth(value) {
}
/**
* Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).
* Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
*/
getFirstSliceAngle() {
}
/**
* Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).
* Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
*/
setFirstSliceAngle(value) {
}
/**
* Specifies how bars and columns are positioned.
* Can be a value between – 100 and 100.
* Applies only to 2-D bar and 2-D column charts.
*/
getOverlap() {
}
/**
* Specifies how bars and columns are positioned.
* Can be a value between – 100 and 100.
* Applies only to 2-D bar and 2-D column charts.
*/
setOverlap(value) {
}
/**
* Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart,
* as a percentage of the size of the primary pie.
* Can be a value from 5 to 200.
*/
getSecondPlotSize() {
}
/**
* Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart,
* as a percentage of the size of the primary pie.
* Can be a value from 5 to 200.
*/
setSecondPlotSize(value) {
}
/**
* Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of
* pie chart.
* The value of the property is ChartSplitType integer constant.
*/
getSplitType() {
}
/**
* Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of
* pie chart.
* The value of the property is ChartSplitType integer constant.
*/
setSplitType(value) {
}
/**
* Returns or sets a value that shall be used to determine which data points are in the second pie or bar on
* a pie of pie or bar of pie chart.
*/
getSplitValue() {
}
/**
* Returns or sets a value that shall be used to determine which data points are in the second pie or bar on
* a pie of pie or bar of pie chart.
*/
setSplitValue(value) {
}
/**
* Indicates whether the threshold value is automatic.
*/
isAutoSplit() {
}
/**
* Gets or sets the scale factor for bubbles in the specified chart group.
* It can be an integer value from 0 (zero) to 300,
* corresponding to a percentage of the default size.
* Applies only to bubble charts.
*/
getBubbleScale() {
}
/**
* Gets or sets the scale factor for bubbles in the specified chart group.
* It can be an integer value from 0 (zero) to 300,
* corresponding to a percentage of the default size.
* Applies only to bubble charts.
*/
setBubbleScale(value) {
}
/**
* Gets or sets what the bubble size represents on a bubble chart.
* The value of the property is BubbleSizeRepresents integer constant.
* BubbleSizeRepresents.SizeIsArea means the value BubbleSizes is the area of the bubble.
* BubbleSizeRepresents.SizeIsWidth means the value BubbleSizes is the width of the bubble.
*/
getSizeRepresents() {
}
/**
* Gets or sets what the bubble size represents on a bubble chart.
* The value of the property is BubbleSizeRepresents integer constant.
* BubbleSizeRepresents.SizeIsArea means the value BubbleSizes is the area of the bubble.
* BubbleSizeRepresents.SizeIsWidth means the value BubbleSizes is the width of the bubble.
*/
setSizeRepresents(value) {
}
/**
* True if negative bubbles are shown for the chart group. Valid only for bubble charts.
*/
getShowNegativeBubbles() {
}
/**
* True if negative bubbles are shown for the chart group. Valid only for bubble charts.
*/
setShowNegativeBubbles(value) {
}
/**
* Returns or sets the size of the hole in a doughnut chart group.
* The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.
*/
getDoughnutHoleSize() {
}
/**
* Returns or sets the size of the hole in a doughnut chart group.
* The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.
*/
setDoughnutHoleSize(value) {
}
/**
* The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
*/
getExplosion() {
}
/**
* The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
*/
setExplosion(value) {
}
/**
* True if a radar chart has category axis labels. Applies only to radar charts.
*/
hasRadarAxisLabels() {
}
/**
* True if a radar chart has category axis labels. Applies only to radar charts.
*/
setHasRadarAxisLabels(value) {
}
/**
* True if the series has leader lines.
*/
hasLeaderLines() {
}
/**
* True if the series has leader lines.
*/
setHasLeaderLines(value) {
}
/**
* Represents leader lines on a chart. Leader lines connect data labels to data points.
* This object isn’t a collection; there’s no object that represents a single leader line.
*/
getLeaderLines() {
}
/**
* Gets the legend entry according to this series.
*/
getLegendEntry() {
}
/**
* Gets the ShapePropertyCollection object that holds the visual shape properties of the Series.
*/
getShapeProperties() {
}
/**
* Gets what the bubble size represents on a bubble chart.
* The value of the property is BubbleSizeRepresents integer constant.
* the bubble size represents on a bubble chart.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Charts.Series.SizeRepresents property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBubbleSizeRepresents() {
}
/**
* Gets what the bubble size represents on a bubble chart.
* The value of the property is BubbleSizeRepresents integer constant.
* the bubble size represents on a bubble chart.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Charts.Series.SizeRepresents property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBubbleSizeRepresents(value) {
}
/**
* Moves the series up or down.
* @param {Number} count - The number of moving up or down.
* Move the series up if this is less than zero;
* Move the series down if this is greater than zero.
*/
move(count) {
}
}
/**
* Encapsulates a collection of Series objects.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Excel object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "A4" cell
* worksheet.getCells().get("A4").putValue(200);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a sample value to "B4" cell
* worksheet.getCells().get("B4").putValue(40);
* //Adding a sample value to "C1" cell as category data
* worksheet.getCells().get("C1").putValue("Q1");
* //Adding a sample value to "C2" cell as category data
* worksheet.getCells().get("C2").putValue("Q2");
* //Adding a sample value to "C3" cell as category data
* worksheet.getCells().get("C3").putValue("Y1");
* //Adding a sample value to "C4" cell as category data
* worksheet.getCells().get("C4").putValue("Y2");
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
* chart.getNSeries().add("A1:B4", true);
* //Setting the data source for the category data of NSeries
* chart.getNSeries().setCategoryData("C1:C4");
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class SeriesCollection {
/**
* Gets or sets the range of category Axis values.
* It can be a range of cells (such as, "d1:e10"),
* or a sequence of values (such as,"{2,6,8,10}").
*/
getCategoryData() {
}
/**
* Gets or sets the range of category Axis values.
* It can be a range of cells (such as, "d1:e10"),
* or a sequence of values (such as,"{2,6,8,10}").
*/
setCategoryData(value) {
}
/**
* Gets or sets the range of second category Axis values.
* It can be a range of cells (such as, "d1:e10"),
* or a sequence of values (such as,"{2,6,8,10}").
* Only effects when some ASerieses plot on the second axis.
*/
getSecondCategoryData() {
}
/**
* Gets or sets the range of second category Axis values.
* It can be a range of cells (such as, "d1:e10"),
* or a sequence of values (such as,"{2,6,8,10}").
* Only effects when some ASerieses plot on the second axis.
*/
setSecondCategoryData(value) {
}
/**
* Represents if the color of points is varied.
*/
isColorVaried() {
}
/**
* Represents if the color of points is varied.
*/
setColorVaried(value) {
}
/**
*/
getCount() {
}
/**
* Gets the Series element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Series} The element at the specified index.
*/
get(index) {
}
/**
* Gets the Series element by order.
* @param {Number} order - The order of series
* @return {Series} The element series
*/
getSeriesByOrder(order) {
}
/**
* Remove at a series at the specific index.
* @param {Number} index - The index.
*/
removeAt(index) {
}
/**
* Directly changes the orders of the two series.
* @param {Number} sourceIndex - The current index
* @param {Number} destIndex - The dest index
*/
changeSeriesOrder(sourceIndex, destIndex) {
}
/**
* Sets the name of all the serieses in the chart.
* If the start index is larger than the count of the serieses, it will return and do nothing.If set data on contiguous cells, use colon to seperate them.For example, $C$2:$C$5.If set data on contiguous cells, use comma to seperate them.For example, ($C$2,$D$5).
* @param {Number} startIndex - The index of the first series which you want to set the name.
* @param {String} area - Specifies the area for the series name.
* @param {boolean} isVertical - >Specifies whether to plot the series from a range of cell values by row or by column.
*/
setSeriesNames(startIndex, area, isVertical) {
}
/**
* Adds the Series collection to a chart.
* If set data on contiguous cells, use colon to seperate them.For example, R[1]C[1]:R[3]C[2].If set data on contiguous cells, use comma to seperate them.For example,(R[1]C[1],R[3]C[2]).
* @param {String} area - Specifies values from which to plot the data series
* @param {boolean} isVertical - Specifies whether to plot the series from a range of cell values by row or by column.
* @return {Number} Return the first index of the added ASeries in the NSeries.
*/
addR1C1(area, isVertical) {
}
/**
* Adds the Series collection to a chart.
* If set data on contiguous cells, use colon to seperate them.For example, $C$2:$C$5.If set data on non contiguous cells, use comma to seperate them.For example: ($C$2,$D$5).
* @param {String} area - Specifies values from which to plot the data series
* @param {boolean} isVertical - Specifies whether to plot the series from a range of cell values by row or by column.
* @return {Number} Return the first index of the added ASeries in the NSeries.
*/
add(area, isVertical) {
}
/**
* Adds the Series collection to a chart.
* If set data on contiguous cells, use colon to seperate them.For example, $C$2:$C$5.If set data on non contiguous cells, use comma to seperate them.For example, ($C$2,$D$5).
* @param {String} area - Specifies values from which to plot the data series
* @param {boolean} isVertical - Specifies whether to plot the series from a range of cell values by row or by column.
* @param {boolean} checkLabels - Indicates whether the range contains series's name
* @return {Number} Return the first index of the added ASeries in the NSeries.
*/
add(area, isVertical, checkLabels) {
}
/**
* Clears the collection
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the properties of series layout.
*/
class SeriesLayoutProperties {
/**
*/
constructor() {
}
/**
* Indicates whether showing connector lines between data points.
*/
getShowConnectorLines() {
}
/**
* Indicates whether showing connector lines between data points.
*/
setShowConnectorLines(value) {
}
/**
* Indicates whether showing the line connecting all mean points.
*/
getShowMeanLine() {
}
/**
* Indicates whether showing the line connecting all mean points.
*/
setShowMeanLine(value) {
}
/**
* Indicates whether showing outlier data points.
*/
getShowOutlierPoints() {
}
/**
* Indicates whether showing outlier data points.
*/
setShowOutlierPoints(value) {
}
/**
* Indicates whether showing markers denoting the mean.
*/
getShowMeanMarker() {
}
/**
* Indicates whether showing markers denoting the mean.
*/
setShowMeanMarker(value) {
}
/**
* Indicates whether showing non-outlier data points.
*/
getShowInnerPoints() {
}
/**
* Indicates whether showing non-outlier data points.
*/
setShowInnerPoints(value) {
}
/**
* Represents the index of a subtotal data point.
*/
getSubtotals() {
}
/**
* Represents the index of a subtotal data point.
*/
setSubtotals(value) {
}
/**
* Represents the statistical properties for the series.
* The value of the property is QuartileCalculationType integer constant.
*/
getQuartileCalculation() {
}
/**
* Represents the statistical properties for the series.
* The value of the property is QuartileCalculationType integer constant.
*/
setQuartileCalculation(value) {
}
/**
* Gets and sets the layout of map labels.
* The value of the property is MapChartLabelLayout integer constant.
*/
getMapLabelLayout() {
}
/**
* Gets and sets the layout of map labels.
* The value of the property is MapChartLabelLayout integer constant.
*/
setMapLabelLayout(value) {
}
/**
* Indicates whether the interval is closed on the left side.
*/
isIntervalLeftClosed() {
}
/**
* Indicates whether the interval is closed on the left side.
*/
setIntervalLeftClosed(value) {
}
/**
* Gets and sets the region type of the map.
* The value of the property is MapChartRegionType integer constant.
*/
getMapChartRegionType() {
}
/**
* Gets and sets the region type of the map.
* The value of the property is MapChartRegionType integer constant.
*/
setMapChartRegionType(value) {
}
/**
* Gets and sets the projection type of the map.
* The value of the property is MapChartProjectionType integer constant.
*/
getMapChartProjectionType() {
}
/**
* Gets and sets the projection type of the map.
* The value of the property is MapChartProjectionType integer constant.
*/
setMapChartProjectionType(value) {
}
}
/**
* Implementation of PivotGlobalizationSettings that supports user to set/change pre-defined texts.
*/
class SettableChartGlobalizationSettings {
/**
*/
constructor() {
}
/**
* Gets the name of Series in the Chart.
* @return {String}
*/
getSeriesName() {
}
/**
* Sets the name of Series in the Chart.
* @param {String} name - local dependent name
*/
setSeriesName(name) {
}
/**
* Gets the name of Chart Title.
* @return {String}
*/
getChartTitleName() {
}
/**
* Sets the name of Chart Title.
* @param {String} name - local dependent name
*/
setChartTitleName(name) {
}
/**
* Gets the name of increase for Legend.
* @return {String}
*/
getLegendIncreaseName() {
}
/**
* Sets the name of increase for Legend.
* @param {String} name - local dependent name
*/
setLegendIncreaseName(name) {
}
/**
* Gets the name of Decrease for Legend.
* @return {String}
*/
getLegendDecreaseName() {
}
/**
* Sets the name of Decrease for Legend.
* @param {String} name - local dependent name
*/
setLegendDecreaseName(name) {
}
/**
* Gets the name of Total for Legend.
* @return {String}
*/
getLegendTotalName() {
}
/**
* Sets the name of Total for Legend.
* @param {String} name - local dependent name
*/
setLegendTotalName(name) {
}
/**
* Gets the name of Title for Axis.
* @return {String}
*/
getAxisTitleName() {
}
/**
* Sets the name of Title for Axis.
* @param {String} name - local dependent name
*/
setAxisTitleName(name) {
}
/**
* Gets the name of "Other" labels for Chart.
* @return {String}
*/
getOtherName() {
}
/**
* Sets the name of "Other" labels for Chart.
* @param {String} name - local dependent name
*/
setOtherName(name) {
}
/**
* Gets the Name of Axis Unit.
* @return {String}
*/
getAxisUnitName(type) {
}
/**
* Sets the Name of Axis Unit.
* @param {String} name - local dependent name
*/
setAxisUnitName(type, name) {
}
}
/**
* Implementation of GlobalizationSettings that supports user to set/change pre-defined texts.
*/
class SettableGlobalizationSettings {
/**
*/
constructor() {
}
/**
* Gets the separator for list, parameters of function, ...etc.
*/
getListSeparator() {
}
/**
* Gets the separator for rows in array data in formula.
*/
getRowSeparatorOfFormulaArray() {
}
/**
* Gets the separator for the items in array's row data in formula.
*/
getColumnSeparatorOfFormulaArray() {
}
/**
* Gets or sets the globalization settings for Chart.
*/
getChartSettings() {
}
/**
* Gets or sets the globalization settings for Chart.
*/
setChartSettings(value) {
}
/**
* Gets or sets the globalization settings for pivot table.
*/
getPivotSettings() {
}
/**
* Gets or sets the globalization settings for pivot table.
*/
setPivotSettings(value) {
}
/**
* Gets the total name of specific function.
* @param {Number} functionType - ConsolidationFunction
* @return {String} The total name of the function.
*/
getTotalName(functionType) {
}
/**
* Sets the total name of specific function.
* @param {Number} functionType - ConsolidationFunction
* @param {String} name - The total name of the function.
*/
setTotalName(functionType, name) {
}
/**
* Gets the grand total name of the function.
* @param {Number} functionType - ConsolidationFunction
* @return {String} The grand total name of the function.
*/
getGrandTotalName(functionType) {
}
/**
* Sets the grand total name of specific function.
* @param {Number} functionType - ConsolidationFunction
* @param {String} name - The grand total name of the function.
*/
setGrandTotalName(functionType, name) {
}
/**
* Gets the type name of table rows that consists of the table header.
* Default is "Headers", so in formula "#Headers" represents the table header.
* @return {String} the type name of table rows
*/
getTableRowTypeOfHeaders() {
}
/**
* Sets the type name of table rows that consists of the table header.
* @param {String} name - the type name of table rows
*/
setTableRowTypeOfHeaders(name) {
}
/**
* 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.
* @return {String} the type name of table rows
*/
getTableRowTypeOfData() {
}
/**
* Sets the type name of table rows that consists of data region of referenced table.
* @param {String} name - the type name of table rows
*/
setTableRowTypeOfData(name) {
}
/**
* Gets the type name of table rows that consists of all rows in referenced table.
* @return {String} the type name of table rows
*/
getTableRowTypeOfAll() {
}
/**
* Sets the type name of table rows that consists of all rows in referenced table.
* @param {String} name - the type name of table rows
*/
setTableRowTypeOfAll(name) {
}
/**
* Gets the type name of table rows that consists of the total row of referenced table.
* @return {String} the type name of table rows
*/
getTableRowTypeOfTotals() {
}
/**
* Sets the type name of table rows that consists of the total row of referenced table.
* @param {String} name - the type name of table rows
*/
setTableRowTypeOfTotals(name) {
}
/**
* Gets the type name of table rows that consists of the current row in referenced table.
* @return {String} the type name of table rows
*/
getTableRowTypeOfCurrent() {
}
/**
* Sets the type name of table rows that consists of the current row in referenced table.
* @param {String} name - the type name of table rows
*/
setTableRowTypeOfCurrent(name) {
}
/**
* Gets the display string value for cell's error value
* @param {String} err - error values such as #VALUE!,#NAME?
* @return {String} By default returns the error value itself
*/
getErrorValueString(err) {
}
/**
* Gets the display string value for cell's boolean value
* @param {boolean} bv - boolean value
* @return {String} By default returns "TRUE" for true value and "FALSE" for false value.
*/
getBooleanValueString(bv) {
}
/**
* Sets the display string value for cell's boolean value
* @param {boolean} bv - boolean value
* @param {String} name - string value of the boolean value
*/
setBooleanValueString(bv, name) {
}
/**
* Gets the locale dependent function name according to given standard function name.
* @param {String} standardName - Standard(en-US locale) function name.
* @return {String} Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
*/
getLocalFunctionName(standardName) {
}
/**
* Sets the locale dependent function name corresponding to given standard function name.
* @param {String} standardName - Standard(en-US locale) function name.
* @param {String} localName - Locale dependent function name
* @param {boolean} 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
*/
setLocalFunctionName(standardName, localName, bidirectional) {
}
/**
* Gets the standard function name according to given locale dependent function name.
* @param {String} localName - Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
* @return {String} Standard(en-US locale) function name.
*/
getStandardFunctionName(localName) {
}
/**
* Sets the locale dependent function name according to given standard function name.
* @param {String} localName - Locale dependent function name
* @param {String} standardName - Standard(en-US locale) function name.
* @param {boolean} 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
*/
setStandardFunctionName(localName, standardName, bidirectional) {
}
/**
* Gets the locale dependent text for built-in Name according to given standard text.
* @param {String} standardName - Standard(en-US locale) text of built-in Name.
* @return {String} Locale dependent text. The locale was specified by the Workbook for which this settings is used.
*/
getLocalBuiltInName(standardName) {
}
/**
* Sets the locale dependent text for the built-in name with given standard name text.
* @param {String} standardName - Standard(en-US locale) name text of built-in name.
* @param {String} localName - Locale dependent name text
* @param {boolean} 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
*/
setLocalBuiltInName(standardName, localName, bidirectional) {
}
/**
* Gets the standard text of built-in Name according to given locale dependent text.
* @param {String} localName - Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used.
* @return {String} Standard(en-US locale) text.
*/
getStandardBuiltInName(localName) {
}
/**
* Sets the locale dependent function name according to given standard function name.
* @param {String} localName - Locale dependent function name
* @param {String} standardName - Standard(en-US locale) function name.
* @param {boolean} 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
*/
setStandardBuiltInName(localName, standardName, bidirectional) {
}
/**
* Sets the separator for list, parameters of function, ...etc.
* @param {char} c - the specified separator
*/
setListSeparator(c) {
}
/**
* Sets the separator for rows in array data in formula.
* @param {char} c - the specified separator
*/
setRowSeparatorOfFormulaArray(c) {
}
/**
* Sets the separator for the items in array's row data in formula.
* @param {char} c - the specified separator
*/
setColumnSeparatorOfFormulaArray(c) {
}
/**
* Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
* @param {String} localfontStyleName - Locale font style name for Header/Footer.
* @return {String} Standard English font style name(Regular, Bold, Italic)
*/
getStandardHeaderFooterFontStyleName(localfontStyleName) {
}
/**
* Sets the locale dependent function name according to given standard function name.
* @param {String} localfontStyleName - Locale font style name for Header/Footer.
* @param {String} standardName - Standard(en-US locale) function name.
*/
setStandardHeaderFooterFontStyleName(localfontStyleName, standardName) {
}
/**
* Gets the locale dependent comment title name according to comment title type.
* @param {Number} type - CommentTitleType
* @return {String} locale dependent comment title name
*/
getCommentTitleName(type) {
}
/**
* Gets the locale dependent comment title name according to comment title type.
* @param {Number} type - CommentTitleType
* @param {String} name - locale dependent comment title name
*/
setCommentTitleName(type, name) {
}
/**
* Gets the name of "Total" label in the PivotTable.
* You need to override this method when the PivotTable contains two or more PivotFields in the data area.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "Total" label
*/
getPivotTotalName() {
}
/**
* Gets the name of "Grand Total" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "Grand Total" label
*/
getPivotGrandTotalName() {
}
/**
* Gets the name of "(Multiple Items)" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "(Multiple Items)" label
*/
getMultipleItemsName() {
}
/**
* Gets the name of "(All)" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use GlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of "(All)" label
*/
getAllName() {
}
/**
* Gets the protection name in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetTextOfProtectedName(string) method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The protection name of PivotTable
*/
getProtectionNameOfPivotTable() {
}
/**
* Gets the name of "Column Labels" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of column labels
*/
getColumnLabelsOfPivotTable() {
}
/**
* Gets the name of "Row Labels" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of row labels
*/
getRowLabelsNameOfPivotTable() {
}
/**
* Gets the name of "(blank)" label in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of empty data
*/
getEmptyDataName() {
}
/**
* Gets the the name of the value area field header in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The name of data field header name
*/
getDataFieldHeaderNameOfPivotTable() {
}
/**
* Gets the name of PivotFieldSubtotalType type in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} subTotalType - PivotFieldSubtotalType
* @return {String} The name of PivotFieldSubtotalType type
*/
getSubTotalName(subTotalType) {
}
/**
* Gets the default sheet name for adding worksheet automatically.
* Default is "Sheet".
* The automatically added(such as by WorksheetCollection.add())
* 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".@return {String} the default sheet name for adding worksheet automatically
*/
getDefaultSheetName() {
}
/**
* Compares two string values according to certain collation rules.
* @param {String} v1 - the first string
* @param {String} v2 - the second string
* @param {boolean} ignoreCase - whether ignore case when comparing values
* @return {Number} Integer that indicates the lexical relationship between the two comparands
*/
compare(v1, v2, ignoreCase) {
}
/**
* Transforms the string into a comparable object according to certain collation rules.
* @param {String} v - String value needs to be compared with others.
* @param {boolean} ignoreCase - whether ignore case when comparing values
* @return {IComparable} Object can be used to compare or sort string values
*/
getCollationKey(v, ignoreCase) {
}
}
/**
* Implementation of PivotGlobalizationSettings that supports user to set/change pre-defined texts.
*/
class SettablePivotGlobalizationSettings {
/**
*/
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.
* @return {String} The text of "Total" label
*/
getTextOfTotal() {
}
/**
* Sets the text of "Total" label in the PivotTable.
* @param {String} text - custom text
*/
setTextOfTotal(text) {
}
/**
* Gets the text of "Grand Total" label in the PivotTable.
* @return {String} The text of "Grand Total" label
*/
getTextOfGrandTotal() {
}
/**
* Sets the text of "Grand Total" label in the PivotTable.
* @param {String} text - custom text
*/
setTextOfGrandTotal(text) {
}
/**
* Gets the text of "(Multiple Items)" label in the PivotTable.
* @return {String} The text of "(Multiple Items)" label
*/
getTextOfMultipleItems() {
}
/**
* Sets the text of "(Multiple Items)" label in the PivotTable.
* @param {String} text - custom text
*/
setTextOfMultipleItems(text) {
}
/**
* Gets the text of "(All)" label in the PivotTable.
* @return {String} The text of "(All)" label
*/
getTextOfAll() {
}
/**
* Sets the text of "(All)" label in the PivotTable.
* @param {String} text - custom text
*/
setTextOfAll(text) {
}
/**
* Gets the text for specified protected name.
* 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.
* @param {String} protectedName - The protected name in PivotTable.
* @return {String} The local prorected names of PivotTable.
*/
getTextOfProtectedName(protectedName) {
}
/**
* Sets the text for specific protected name.
* @param {String} protectedName - The protected name in PivotTable.
* @param {String} text - The local prorected names of PivotTable.
*/
setTextOfProtectedName(protectedName, text) {
}
/**
* Gets the text of "Column Labels" label in the PivotTable.
* @return {String} The text of column labels
*/
getTextOfColumnLabels() {
}
/**
* Gets the text of "Column Labels" label in the PivotTable.
* @param {String} text - The text of column labels
*/
setTextOfColumnLabels(text) {
}
/**
* Gets the text of "Row Labels" label in the PivotTable.
* @return {String} The text of row labels
*/
getTextOfRowLabels() {
}
/**
* Sets the text of "Row Labels" label in the PivotTable.
* @param {String} text - The text of row labels
*/
setTextOfRowLabels(text) {
}
/**
* Gets the text of "(blank)" label in the PivotTable.
* @return {String} The text of empty data
*/
getTextOfEmptyData() {
}
/**
* Sets the text of "(blank)" label in the PivotTable.
* @param {String} text - The text of empty data
*/
setTextOfEmptyData(text) {
}
/**
* Gets the the text of the value area field header in the PivotTable.
* @return {String} The text of data field header name
*/
getTextOfDataFieldHeader() {
}
/**
* Sets the the text of the value area field header in the PivotTable.
* @param {String} text - The text of data field header name
*/
setTextOfDataFieldHeader(text) {
}
/**
* Gets the text of PivotFieldSubtotalType type in the PivotTable.
* @param {Number} subTotalType - PivotFieldSubtotalType
* @return {String} The text of given type
*/
getTextOfSubTotal(subTotalType) {
}
/**
* Sets the text of PivotFieldSubtotalType type in the PivotTable.
* @param {Number} subTotalType - PivotFieldSubtotalType
* @param {String} text - The text of given type
*/
setTextOfSubTotal(subTotalType, text) {
}
/**
* Gets the protection name in the PivotTable.
* NOTE: This member is now obsolete. Instead,
* please use PivotGlobalizationSettings.GetTextOfProtectedName(string) method.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.@return {String} The protection name of PivotTable
*/
getTextOfProtection() {
}
/**
* Gets all short formatted string of 12 months.
* @return {String[]}
*/
getShortTextOf12Months() {
}
/**
* Gets the local text of 4 Quaters.
* @return {String[]}
*/
getTextOf4Quaters() {
}
/**
* Gets the local text of "Years".
* @return {String}
*/
getTextOfYears() {
}
/**
* Get the local text of "Quarters".
* @return {String}
*/
getTextOfQuarters() {
}
/**
* Gets the local text of "Months".
* @return {String}
*/
getTextOfMonths() {
}
/**
* Gets the local text of "Days".
* @return {String}
*/
getTextOfDays() {
}
/**
* Gets the local text of "Hours".
* @return {String}
*/
getTextOfHours() {
}
/**
* Gets the local text of "Minutes".
* @return {String}
*/
getTextOfMinutes() {
}
/**
* Gets the local text of "Seconds"
* @return {String}
*/
getTextOfSeconds() {
}
/**
* Gets the local text of "Range"
* @return {String}
*/
getTextOfRange() {
}
}
/**
* This class specifies the shadow effect of the chart element or shape.
* @hideconstructor
*/
class ShadowEffect {
/**
* Gets and sets the preset shadow type of the shadow.
* The value of the property is PresetShadowType integer constant.
*/
getPresetType() {
}
/**
* Gets and sets the preset shadow type of the shadow.
* The value of the property is PresetShadowType integer constant.
*/
setPresetType(value) {
}
/**
* Gets and sets the color of the shadow.
*/
getColor() {
}
/**
* Gets and sets the color of the shadow.
*/
setColor(value) {
}
/**
* Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).
*/
getTransparency() {
}
/**
* Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets and sets the size of the shadow. Range from 0 to 2.0.
* Meaningless in inner shadow.
*/
getSize() {
}
/**
* Gets and sets the size of the shadow. Range from 0 to 2.0.
* Meaningless in inner shadow.
*/
setSize(value) {
}
/**
* Gets and sets the blur of the shadow. Range from 0 to 100 points.
*/
getBlur() {
}
/**
* Gets and sets the blur of the shadow. Range from 0 to 100 points.
*/
setBlur(value) {
}
/**
* Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
*/
getAngle() {
}
/**
* Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
*/
setAngle(value) {
}
/**
* Gets and sets the distance of the shadow. Range from 0 to 200 points.
*/
getDistance() {
}
/**
* Gets and sets the distance of the shadow. Range from 0 to 200 points.
*/
setDistance(value) {
}
}
/**
* Represents the msodrawing object.
* @hideconstructor
*/
class Shape {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
/**
* Saves the shape to a stream.
* @param {Shape} shape - The Shape object
* @param {WritableStream} stream - The stream of the output image
* @param {ImageOrPrintOptions} options - Addtional image creation options
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var shape = workbook.getWorksheets().get("Shape").getShapes().get(0);
* var imgWriteStream = fs.createWriteStream("shape1.jpeg");
* var imgOptions = new aspose.cells.ImageOrPrintOptions();
* imgOptions.setHorizontalResolution(200);
* imgOptions.setVerticalResolution(300);
* imgOptions.setImageFormat(aspose.cells.ImageFormat.getJpeg());
* aspose.cells.Shape.toImageStream(shape, imgWriteStream, imgOptions);
*/
static toImageStream(shape, stream, options) {
}
/**
* Creates the shape image and saves it to a stream in the specified format.
* The following formats are supported:
* .bmp, .gif, .jpg, .jpeg, .tiff, .emf.
* @param {Shape} shape - The Shape object
* @param {WritableStream} stream - The stream of the output image
* @param {ImageFormat} imageFormat - The format in which to save the image
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var shape = workbook.getWorksheets().get("Shape").getShapes().get(0);
* var imangeFormatJpeg = aspose.cells.ImageFormat.getJpeg();
* imgWriteStream = fs.createWriteStream("shape2.jpeg");
* shape = workbook.getWorksheets().get("Shape").getShapes().get(1);
* aspose.cells.Shape.toImageStream(shape, imgWriteStream, imangeFormatJpeg);
*/
static toImageStream(shape, stream, imageFormat) {
}
}
/**
* Represents all the shape in a worksheet/chart.
* @hideconstructor
*/
class ShapeCollection {
/**
*/
getCount() {
}
/**
* Gets the shape object at the specific index.
* @param {Number} index
* @return {Shape}
*/
get(index) {
}
/**
* Gets the shape object by the shape image
* @param {String} name
* @return {Shape}
*/
get(name) {
}
/**
* Adds and copy a shape to the worksheet.
* @param {Shape} sourceShape - Source shape.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of checkbox from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of textbox from its left column, in unit of pixel.
* @return {Shape} The new shape object index.
*/
addCopy(sourceShape, upperLeftRow, top, upperLeftColumn, left) {
}
/**
* Adds a checkbox to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of checkbox from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of textbox from its left column, in unit of pixel.
* @param {Number} height - Height of textbox, in unit of pixel.
* @param {Number} width - Width of textbox, in unit of pixel.
* @return {CheckBox} The new CheckBox object index.
*/
addCheckBox(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a text box to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of textbox from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of textbox from its left column, in unit of pixel.
* @param {Number} height - Represents the height of textbox, in unit of pixel.
* @param {Number} width - Represents the width of textbox, in unit of pixel.
* @return {TextBox} A TextBox object.
*/
addTextBox(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Add an equation object to the worksheet.
* @param {Number} upperLeftRow
* @param {Number} top
* @param {Number} upperLeftColumn
* @param {Number} left
* @param {Number} height
* @param {Number} width
* @return {TextBox}
*/
addEquation(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a Spinner to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of Spinner from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of Spinner from its left column, in unit of pixel.
* @param {Number} height - Represents the height of Spinner, in unit of pixel.
* @param {Number} width - Represents the width of Spinner, in unit of pixel.
* @return {Spinner} A Spinner object.
*/
addSpinner(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a ScrollBar to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of ScrollBar from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of ScrollBar from its left column, in unit of pixel.
* @param {Number} height - Represents the height of ScrollBar, in unit of pixel.
* @param {Number} width - Represents the width of ScrollBar, in unit of pixel.
* @return {ScrollBar} A ScrollBar object.
*/
addScrollBar(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a RadioButton to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of RadioButton from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of RadioButton from its left column, in unit of pixel.
* @param {Number} height - Represents the height of RadioButton, in unit of pixel.
* @param {Number} width - Represents the width of RadioButton, in unit of pixel.
* @return {RadioButton} A RadioButton object.
*/
addRadioButton(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a ListBox to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of ListBox from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of ListBox from its left column, in unit of pixel.
* @param {Number} height - Represents the height of ListBox, in unit of pixel.
* @param {Number} width - Represents the width of ListBox, in unit of pixel.
* @return {ListBox} A ListBox object.
*/
addListBox(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a ComboBox to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of ComboBox from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of ComboBox from its left column, in unit of pixel.
* @param {Number} height - Represents the height of ComboBox, in unit of pixel.
* @param {Number} width - Represents the width of ComboBox, in unit of pixel.
* @return {ComboBox} A ComboBox object.
*/
addComboBox(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a GroupBox to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of GroupBox from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of GroupBox from its left column, in unit of pixel.
* @param {Number} height - Represents the height of GroupBox, in unit of pixel.
* @param {Number} width - Represents the width of GroupBox, in unit of pixel.
* @return {GroupBox} A GroupBox object.
*/
addGroupBox(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a Button to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of Button from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of Button from its left column, in unit of pixel.
* @param {Number} height - Represents the height of Button, in unit of pixel.
* @param {Number} width - Represents the width of Button, in unit of pixel.
* @return {Button} A Button object.
*/
addButton(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a Label to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of Label from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of Label from its left column, in unit of pixel.
* @param {Number} height - Represents the height of Label, in unit of pixel.
* @param {Number} width - Represents the width of Label, in unit of pixel.
* @return {Label} A Label object.
*/
addLabel(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a label to the chart.
* @param {Number} top - Represents the vertical offset of label from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} left - Represents the vertical offset of label from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} height - Represents the height of label, in units of 1/4000 of the chart area.
* @param {Number} width - Represents the width of label, in units of 1/4000 of the chart area.
* @return {Label} A new Label object.
*/
addLabelInChart(top, left, height, width) {
}
/**
* Adds a textbox to the chart.
* @param {Number} top - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} left - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} height - Represents the height of textbox, in units of 1/4000 of the chart area.
* @param {Number} width - Represents the width of textbox, in units of 1/4000 of the chart area.
* @return {TextBox} A TextBox object.
*/
addTextBoxInChart(top, left, height, width) {
}
/**
* Inserts a WordArt object to the chart
* @param {Number} effect - MsoPresetTextEffect
* @param {String} text - The WordArt text.
* @param {String} fontName - The font name.
* @param {Number} size - The font size
* @param {boolean} fontBold - Indicates whether font is bold.
* @param {boolean} fontItalic - Indicates whether font is italic.
* @param {Number} top - Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} left - Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} height - Represents the height of shape, in units of 1/4000 of the chart area.
* @param {Number} width - Represents the width of shape, in units of 1/4000 of the chart area.
* @return {Shape} Returns a Shape object that represents the new WordArt object.
*/
addTextEffectInChart(effect, text, fontName, size, fontBold, fontItalic, top, left, height, width) {
}
/**
* Inserts a WordArt object.
* @param {Number} effect - MsoPresetTextEffect
* @param {String} text - The WordArt text.
* @param {String} fontName - The font name.
* @param {Number} size - The font size
* @param {boolean} fontBold - Indicates whether font is bold.
* @param {boolean} fontItalic - Indicates whether font is italic.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of shape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of shape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of shape, in unit of pixel.
* @param {Number} width - Represents the width of shape, in unit of pixel.
* @return {Shape} Returns a Shape object that represents the new WordArt object.
*/
addTextEffect(effect, text, fontName, size, fontBold, fontItalic, upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds preset WordArt since Excel 2007.s
* @param {Number} style - PresetWordArtStyle
* @param {String} text - The text.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of shape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of shape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of shape, in unit of pixel.
* @param {Number} width - Represents the width of shape, in unit of pixel.
* @return {Shape}
*/
addWordArt(style, text, upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a RectangleShape to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of RectangleShape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of RectangleShape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of RectangleShape, in unit of pixel.
* @param {Number} width - Represents the width of RectangleShape, in unit of pixel.
* @return {RectangleShape} A RectangleShape object.
*/
addRectangle(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a Oval to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of Oval from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of Oval from its left column, in unit of pixel.
* @param {Number} height - Represents the height of Oval, in unit of pixel.
* @param {Number} width - Represents the width of Oval, in unit of pixel.
* @return {Oval} A Oval object.
*/
addOval(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a LineShape to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of LineShape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of LineShape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of LineShape, in unit of pixel.
* @param {Number} width - Represents the width of LineShape, in unit of pixel.
* @return {LineShape} A LineShape object.
*/
addLine(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a free floating shape to the worksheet.Only applies for line/image shape.
* @param {Number} type - MsoDrawingType
* @param {Number} top - Represents the vertical offset of shape from the worksheet's top row, in unit of pixel.
* @param {Number} left - Represents the horizontal offset of shape from the worksheet's left column, in unit of pixel.
* @param {Number} height - Represents the height of LineShape, in unit of pixel.
* @param {Number} width - Represents the width of LineShape, in unit of pixel.
* @param {byte[]} imageData - The image data,only applies for the picture.
* @param {boolean} isOriginalSize - Whether the shape use original size if the shape is image.
* @return {Shape}
*/
addFreeFloatingShape(type, top, left, height, width, imageData, isOriginalSize) {
}
/**
* Add a shape to chart .All unit is 1/4000 of chart area.
* @param {Number} type - MsoDrawingType
* @param {Number} placement - PlacementType
* @param {Number} left - In unit of 1/4000 chart area width.
* @param {Number} top - In unit of 1/4000 chart area height.
* @param {Number} right - In unit of 1/4000 chart area width.
* @param {Number} bottom - In unit of 1/4000 chart area height.
* @param {byte[]} imageData - If the shape is not a picture or ole object,imageData should be null.
*/
addShapeInChart(type, placement, left, top, right, bottom, imageData) {
}
/**
* Add a shape to chart .All unit is 1/4000 of chart area.
* @param {Number} type - MsoDrawingType
* @param {Number} placement - PlacementType
* @param {Number} left - In unit of 1/4000 chart area width.
* @param {Number} top - In unit of 1/4000 chart area height.
* @param {Number} right - In unit of 1/4000 chart area width.
* @param {Number} bottom - In unit of 1/4000 chart area height.
*/
addShapeInChart(type, placement, left, top, right, bottom) {
}
/**
* Add a shape to chart. All unit is percent scale of chart area.
* @param {Number} type - MsoDrawingType
* @param {Number} placement - PlacementType
* @param {Number} left - Unit is percent scale of chart area width.
* @param {Number} top - Unit is percent scale of chart area height.
* @param {Number} right - Unit is percent scale of chart area width.
* @param {Number} bottom - Unit is percent scale of chart area height.
*/
addShapeInChartByScale(type, placement, left, top, right, bottom) {
}
/**
* Add a shape to chart .All unit is 1/4000 of chart area.
* @param {Number} type - MsoDrawingType
* @param {Number} placement - PlacementType
* @param {Number} left - Unit is percent scale of chart area width.
* @param {Number} top - Unit is percent scale of chart area height.
* @param {Number} right - Unit is percent scale of chart area width.
* @param {Number} bottom - Unit is percent scale of chart area height.
* @param {byte[]} imageData - If the shape is not a picture or ole object,imageData should be null.
*/
addShapeInChartByScale(type, placement, left, top, right, bottom, imageData) {
}
/**
* Adds a ArcShape to the worksheet.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of ArcShape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of ArcShape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of ArcShape, in unit of pixel.
* @param {Number} width - Represents the width of ArcShape, in unit of pixel.
* @return {ArcShape} A ArcShape object.
*/
addArc(upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a Shape to the worksheet.
* The type could not be Chart/Comment/Picture/OleObject/Polygon/DialogBox
* @param {Number} type - MsoDrawingType
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of Shape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of Shape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of Shape, in unit of pixel.
* @param {Number} width - Represents the width of Shape, in unit of pixel.
* @return {Shape} A Shape object.
*/
addShape(type, upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a AutoShape to the worksheet.
* The type could not be Chart/Comment/Picture/OleObject/Polygon/DialogBox
* @param {Number} type - AutoShapeType
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of Shape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of Shape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of Shape, in unit of pixel.
* @param {Number} width - Represents the width of Shape, in unit of pixel.
* @return {Shape} A Shape object.
*/
addAutoShape(type, upperLeftRow, top, upperLeftColumn, left, height, width) {
}
/**
* Adds a AutoShape to the chart.
* The type could not be Chart/Comment/Picture/OleObject/Polygon/DialogBox
* @param {Number} type - AutoShapeType
* @param {Number} top - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} left - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
* @param {Number} height - Represents the height of textbox, in units of 1/4000 of the chart area.
* @param {Number} width - Represents the width of textbox, in units of 1/4000 of the chart area.
* @return {Shape} Returns a shape object.
*/
addAutoShapeInChart(type, top, left, height, width) {
}
/**
* Creates an Activex Control.
* @param {Number} type - ControlType
* @param {Number} topRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of Shape from its left row, in unit of pixel.
* @param {Number} leftColumn - Upper left column index.
* @param {Number} left - Represents the horizontal offset of Shape from its left column, in unit of pixel.
* @param {Number} height - Represents the height of Shape, in unit of pixel.
* @param {Number} width - Represents the width of Shape, in unit of pixel.
* @return {Shape}
*/
addActiveXControl(type, topRow, top, leftColumn, left, width, height) {
}
/**
* Adds svg image.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of shape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - The horizontal offset of shape from its left column, in unit of pixel.
* @param {Number} height - The height of shape, in unit of pixel.
* @param {Number} width - The width of shape, in unit of pixel.
* @param {byte[]} svgData - The svg image data.
* @param {byte[]} compatibleImageData - Converted image data from svg in order to be compatible with Excel 2016 or lower versions.
* @return {Picture}
*/
addSvg(upperLeftRow, top, upperLeftColumn, left, height, width, svgData, compatibleImageData) {
}
/**
* Adds svg image.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} top - Represents the vertical offset of shape from its left row, in unit of pixel.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} left - The horizontal offset of shape from its left column, in unit of pixel.
* @param {Number} height - The height of shape, in unit of pixel.
* @param {Number} width - The width of shape, in unit of pixel.
* @param {byte[]} imageByteData - The image byte data.
* @param {byte[]} compatibleImageData - Converted image data from svg in order to be compatible with Excel 2016 or lower versions.
* @return {Picture}
*/
addIcons(upperLeftRow, top, upperLeftColumn, left, height, width, imageByteData, compatibleImageData) {
}
/**
* Add a linked picture.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} height - The height of the shape. In unit of pixels
* @param {Number} width - The width of the shape. In unit of pixels
* @param {String} sourceFullName -
* The path and name of the source file for the linked image
* @return {Picture} Picture Picture object.
*/
addLinkedPicture(upperLeftRow, upperLeftColumn, height, width, sourceFullName) {
}
/**
* Add a linked picture.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} height - The height of the shape. In unit of pixels
* @param {Number} width - The width of the shape. In unit of pixels
* @param {String} sourceFullName -
* The path and name of the source file for the linked image
* @return {OleObject} Picture Picture object.
*/
addOleObjectWithLinkedImage(upperLeftRow, upperLeftColumn, height, width, sourceFullName) {
}
/**
* Adds an OleObject.
* @param {Number} upperLeftRow
* @param {Number} top
* @param {Number} upperLeftColumn
* @param {Number} left
* @param {Number} height
* @param {Number} width
* @param {byte[]} imageData
* @return {OleObject}
*/
addOleObject(upperLeftRow, top, upperLeftColumn, left, height, width, imageData) {
}
/**
* Copy all comments in the range.
* @param {ShapeCollection} shapes - The source shapes.
* @param {CellArea} ca - The source range.
* @param {Number} destRow - The dest range start row.
* @param {Number} destColumn - The dest range start column.
*/
copyCommentsInRange(shapes, ca, destRow, destColumn) {
}
/**
* Copy shapes in the range to destination range.
* @param {ShapeCollection} sourceShapes - Source shapes.
* @param {CellArea} ca - The source range.
* @param {Number} destRow - The dest row index of the dest range.
* @param {Number} destColumn - The dest column of the dest range.
* @param {boolean} isContained - Whether only copy the shapes which are contained in the range.
* If true,only copies the shapes in the range.
* Otherwise,it works as MS Office.
*/
copyInRange(sourceShapes, ca, destRow, destColumn, isContained) {
}
/**
* Delete shapes in the range.Comment shapes will not be deleted.
* @param {CellArea} ca - The range.If the shapes are contained in the range, they will be removed.
*/
deleteInRange(ca) {
}
/**
* Delete a shape. If the shape is in the group or is a comment shape, it will not be deleted.
* @param {Shape} shape
*/
deleteShape(shape) {
}
/**
* Group the shapes.
* The shape in the groupItems should not be grouped.
* The shape must be in this Shapes collection.
* @param {Shape[]} groupItems - the group items.
* @return {GroupShape} Return the group shape.
*/
group(groupItems) {
}
/**
* Ungroups the shape items.
* If the group shape is grouped by another group shape,nothing will be done.
* @param {GroupShape} group - The group shape.
*/
ungroup(group) {
}
/**
* Remove the shape.
* @param {Number} index - The index of the shape.
*/
removeAt(index) {
}
/**
* Remove the shape.
* @param {Shape} shape
*/
remove(shape) {
}
/**
* Clear all shapes.
*/
clear() {
}
/**
* Update the selected value by the value of the linked cell of the shapes.
*/
updateSelectedValue() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
/**
* Adds a picture to the collection.
* @param {PictureCollection} pictures - The PictureCollection object
* @param {Number} upperLeftRow - Upper left row index
* @param {Number} upperLeftColumn - Upper left column index
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
* @param {ReadableStream} stream - Stream object which contains the image data
* @param {Callback} callback - The callback function
* @return {object} Returns a Picture objct
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook();
* var shapes = workbook.getWorksheets().get(0).getShapes();
* var shapeStream = fs.createReadStream("boxing.PNG");
* aspose.cells.ShapeCollection.addPictureFromStream(shapes, 1, 1, 10, 5, shapeStream,
* function(picture, err) {
* if (!err) {
* console.log("addPictureFromStream done");
* }
* workbook.save('result.xlsx');
* }
* );
*/
static addPictureFromStream(pictures, upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn, stream, callback) {
}
/**
* Adds a picture to the collection.
* @param {PictureCollection} pictures - The PictureCollection object
* @param {Number} upperLeftRow - Upper left row index
* @param {Number} upperLeftColumn - Upper left column index
* @param {ReadableStream} stream - Stream object which contains the image data
* @param {Number} widthScale - Scale of image width, a percentage
* @param {Number} heightScale - Scale of image height, a percentage
* @param {Callback} callback - The callback function
* @return {object} Returns a Picture objct
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook();
* var shapes = workbook.getWorksheets().get(0).getShapes();
* var shapeStream = fs.createReadStream("boxing.PNG");
* aspose.cells.ShapeCollection.addPictureFromStream(shapes, 1, 1, shapeStream, 80, 60,
* function(picture, err) {
* if (!err) {
* console.log("addPictureFromStream done");
* }
* workbook.save('result.xlsx');
* }
* );
*/
static addPictureFromStream(pictures, upperLeftRow, upperLeftColumn, stream, widthScale, heightScale, callback) {
}
/**
* Adds a picture to the chart.
* @param {PictureCollection} pictures - The PictureCollection object
* @param {Number} top - Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area
* @param {Number} left - Represents the horizontal offset of shape from the upper left corner in units of 1/4000 of the chart area
* @param {ReadableStream} stream - Stream object which contains the image data
* @param {Number} widthScale - Scale of image width, a percentage
* @param {Number} heightScale - Scale of image height, a percentage
* @param {Callback} callback - The callback function
* @return {object} Returns a Picture objct
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var shapes = workbook.getWorksheets().get("Chart").getCharts().get(0).getShapes();
* var shapeStream = fs.createReadStream("boxing.PNG");
* aspose.cells.ShapeCollection.addPictureInChartFromStream(shapes, 1, 1, shapeStream, 10, 5,
* function(picture, err) {
* if (!err) {
* console.log("addPictureInChartFromStream done");
* }
* workbook.save('result.xlsx');
* }
* );
*/
static addPictureInChartFromStream(pictures, top, left, stream, widthScale, heightScale, callback) {
}
}
/**
* Encapsulates a shape guide specifies the presence of a shape guide that will be used to
* govern the geometry of the specified shape
* @hideconstructor
*/
class ShapeGuide {
/**
* Gets or sets value of this guide
*/
getValue() {
}
/**
* Gets or sets value of this guide
*/
setValue(value) {
}
}
/**
* Encapsulates a collection of shape guide
*/
class ShapeGuideCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets a shape guide by index
* @param {Number} index
* @return {ShapeGuide}
*/
get(index) {
}
/**
* Adds a shape guide.(Important: This feature is currently only available for Excel07 and above)
* @param {String} name - the name of adjust. It's as "adj(Used when there is only one adjustment value)", "adj1", "adj2", "adj3" and so on.
* @param {Number} val - the value of adjust
*/
add(name, val) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents a creation path consisting of a series of moves, lines and curves that when combined will form a geometric shape.
*/
class ShapePath {
/**
* Initializes a new instance of the ShapePath class.
*/
constructor() {
}
/**
* Gets ShapeSegmentPathCollection list
*/
getPathSegementList() {
}
}
/**
* Represents path collection information in NotPrimitive autoshape
* @hideconstructor
*/
class ShapePathCollection {
/**
* Gets the count of paths
*/
getCount() {
}
/**
* Gets a creation path.
* @param {Number} index - The index.
* @return {ShapePath} Returns ShapePath object.
*/
get(index) {
}
/**
* Add a creation path.
* @return {Number} Returns ShapePath object.
*/
add() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents an x-y coordinate within the path coordinate space.
* @hideconstructor
*/
class ShapePathPoint {
/**
* Gets and sets x coordinate for this position coordinate.
*/
getX() {
}
/**
* Gets and sets x coordinate for this position coordinate.
*/
setX(value) {
}
/**
* Gets y coordinate for this position coordinate.
*/
getY() {
}
/**
* Gets y coordinate for this position coordinate.
*/
setY(value) {
}
}
/**
* Represents all shape path points.
*/
class ShapePathPointCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets shape path point by index.
* @param {Number} index - The index
* @return {ShapePathPoint} Returns ShapePathPoint object
*/
get(index) {
}
/**
* Adds a path point.
* @param {Number} x - The x coordinate.
* @param {Number} y - The y coordinate.
*/
add(x, y) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* This class specifies the visual shape properties for a chart element or shape.
* @hideconstructor
*/
class ShapePropertyCollection {
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlowEffect() {
}
/**
* Represents a Format3D object that specifies 3D shape properties for the chart element or shape.
*/
getFormat3D() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdgeRadius() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdgeRadius(value) {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Clears the glow effect of the shape.
*/
clearGlowEffect() {
}
/**
* Indicates if the shape has glow effect data.
* @return {boolean}
*/
hasGlowEffect() {
}
/**
* Indicates if the shape has 3d format data.
* @return {boolean}
*/
hasFormat3D() {
}
/**
* Clears the 3D shape properties of the shape.
*/
clearFormat3D() {
}
/**
* Clears the shadow effect of the chart element or shape.
*/
clearShadowEffect() {
}
/**
* Indicates if the shape has shadow effect data.
* @return {boolean}
*/
hasShadowEffect() {
}
}
/**
* Represents a segment path in a path of the freeform.
* @hideconstructor
*/
class ShapeSegmentPath {
/**
* Gets the path segment type
* The value of the property is ShapePathType integer constant.
*/
getType() {
}
/**
* Gets the points in path segment
*/
getPoints() {
}
}
/**
* Represents a creation path consisting of a series of moves, lines and curves that when combined will form a geometric shape.
*/
class ShapeSegmentPathCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets ShapeSegmentPath object.
* @param {Number} index - The index.
* @return {ShapeSegmentPath} Returns a ShapeSegmentPath object.
*/
get(index) {
}
/**
* Add a segment path in creation path.
* @param {Number} type - ShapePathType
* @return {Number} Returns the position of ShapeSegmentPath object in the list.
*/
add(type) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the setting of shape's text alignment;
* @hideconstructor
*/
class ShapeTextAlignment {
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Indicates whether rotating text with shape.
*/
getRotateTextWithShape() {
}
/**
* Indicates whether rotating text with shape.
*/
setRotateTextWithShape(value) {
}
/**
* Gets and sets the text vertical overflow type of the text box.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the text box.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the text box.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the text box.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets and sets the text direction.
* The value of the property is TextVerticalType integer constant.
*/
getTextVerticalType() {
}
/**
* Gets and sets the text direction.
* The value of the property is TextVerticalType integer constant.
*/
setTextVerticalType(value) {
}
/**
* Indicates whether the shape is locked when worksheet is protected.
* Only works when worksheet is protected.
*/
isLockedText() {
}
/**
* Indicates whether the shape is locked when worksheet is protected.
* Only works when worksheet is protected.
*/
setLockedText(value) {
}
/**
* Indicates if size of shape is adjusted automatically according to its content.
*/
getAutoSize() {
}
/**
* Indicates if size of shape is adjusted automatically according to its content.
*/
setAutoSize(value) {
}
/**
* Gets and set the transform type of text.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and set the transform type of text.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Returns the top margin in unit of Points
*/
getTopMarginPt() {
}
/**
* Returns the top margin in unit of Points
*/
setTopMarginPt(value) {
}
/**
* Returns the bottom margin in unit of Points
*/
getBottomMarginPt() {
}
/**
* Returns the bottom margin in unit of Points
*/
setBottomMarginPt(value) {
}
/**
* Returns the left margin in unit of Points
*/
getLeftMarginPt() {
}
/**
* Returns the left margin in unit of Points
*/
setLeftMarginPt(value) {
}
/**
* Returns the right margin in unit of Points
*/
getRightMarginPt() {
}
/**
* Returns the right margin in unit of Points
*/
setRightMarginPt(value) {
}
/**
* Indicates whether the margin of the text frame is automatic.
*/
isAutoMargin() {
}
/**
* Indicates whether the margin of the text frame is automatic.
*/
setAutoMargin(value) {
}
/**
* Gets and sets the number of columns of text in the bounding rectangle.
*/
getNumberOfColumns() {
}
/**
* Gets and sets the number of columns of text in the bounding rectangle.
*/
setNumberOfColumns(value) {
}
/**
* Determines whether this instance has the same value as another specified ShapeTextAlignment object.
* @param {Object} obj - The
* @return {boolean} 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) {
}
/**
* @return {Number}
*/
hashCode() {
}
}
/**
* Worksheet printing preview.
*/
class SheetPrintingPreview {
/**
* The construct of SheetPrintingPreview
* @param {Worksheet} sheet - Indicate which spreadsheet to be printed.
* @param {ImageOrPrintOptions} options - ImageOrPrintOptions contains some property of output
*/
constructor(sheet, options) {
}
/**
* Evaluate the total page count of this worksheet
*/
getEvaluatedPageCount() {
}
}
/**
* 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.
*/
class SheetRender {
/**
* the construct of SheetRender, need worksheet and ImageOrPrintOptions as params
* @param {Worksheet} worksheet - Indicate which spreadsheet to be rendered.
* @param {ImageOrPrintOptions} options - ImageOrPrintOptions contains some property of output image
*/
constructor(worksheet, options) {
}
/**
* Gets the total page count of current worksheet.
*/
getPageCount() {
}
/**
* Gets calculated page scale of the sheet.
* Returns the set scale if PageSetup.Zoom is set. Otherwise, returns the calculated scale according to PageSetup.FitToPagesWide and PageSetup.FitToPagesTall.
*/
getPageScale() {
}
/**
* Get page size in inch of output image.
* @param {Number} pageIndex - The page index is based on zero.
* @return {float[]} Page size of image, [0] for width and [1] for height
*/
getPageSizeInch(pageIndex) {
}
/**
* Render certain page to a file.
* @param {Number} pageIndex - indicate which page is to be converted
* @param {String} fileName - filename of the output image
*/
toImage(pageIndex, fileName) {
}
/**
* Render worksheet to Printer
* @param {String} printerName - the name of the printer , for example: "Microsoft Office Document Image Writer"
*/
toPrinter(printerName) {
}
/**
* Render worksheet to Printer
* @param {String} printerName - the name of the printer , for example: "Microsoft Office Document Image Writer"
* @param {String} jobName - set the print job name
*/
toPrinter(printerName, jobName) {
}
/**
* Render certain page to a stream.
* @param {SheetRender} sheetRender - The SheetRender object
* @param {Number} pageIndex - Indicate which page is to be converted
* @param {WritableStream} stream - The stream of the output image
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var imgOptions = new aspose.cells.ImageOrPrintOptions();
* imgOptions.setHorizontalResolution(200);
* imgOptions.setVerticalResolution(300);
* imgOptions.setImageFormat(aspose.cells.ImageFormat.getJpeg());
* var worksheet = workbook.getWorksheets().get(0);
* var sheetRender = new aspose.cells.SheetRender(worksheet, imgOptions);
* var imgWriteStream = fs.createWriteStream("sheet1.jpeg");
* aspose.cells.SheetRender.toImageStream(sheetRender, 0, imgWriteStream);
*/
static toImageStream(sheetRender, pageIndex, stream) {
}
}
/**
* Describes a set of sheets.
*/
class SheetSet {
/**
* Creates a sheet set based on exact sheet indexes.
* If a sheet is encountered that is not in the workbook, an exception will be thrown during rendering.
* @param {Number[]} sheets - zero based sheet indexes.
*/
constructor(sheets) {
}
/**
* Gets a set with active sheet of the workbook.
*/
getActive() {
}
/**
* Gets a set with visible sheets of the workbook in their original order.
*/
getVisible() {
}
/**
* Gets a set with all sheets of the workbook in their original order.
*/
getAll() {
}
}
/**
* Represent the signature line.
*/
class SignatureLine {
/**
*/
constructor() {
}
/**
* Gets or sets identifier for this signature line.
*/
getId() {
}
/**
* Gets or sets identifier for this signature line.
*/
setId(value) {
}
/**
* Gets and sets the id of signature provider.
* It's typically the CLSID of the provider com add-in.
*/
getProviderId() {
}
/**
* Gets and sets the id of signature provider.
* It's typically the CLSID of the provider com add-in.
*/
setProviderId(value) {
}
/**
* Gets and sets the signer.
*/
getSigner() {
}
/**
* Gets and sets the signer.
*/
setSigner(value) {
}
/**
* Gets and sets the title of singer.
*/
getTitle() {
}
/**
* Gets and sets the title of singer.
*/
setTitle(value) {
}
/**
* Gets and sets the email of singer.
*/
getEmail() {
}
/**
* Gets and sets the email of singer.
*/
setEmail(value) {
}
/**
* Indicates whether it is a signature line.
*/
isLine() {
}
/**
* Indicates whether it is a signature line.
*/
setLine(value) {
}
/**
* Indicates whether comments could be attached.
*/
getAllowComments() {
}
/**
* Indicates whether comments could be attached.
*/
setAllowComments(value) {
}
/**
* Indicates whether show signed date.
*/
getShowSignedDate() {
}
/**
* Indicates whether show signed date.
*/
setShowSignedDate(value) {
}
/**
* Gets and sets the text shown to user at signing time.
*/
getInstructions() {
}
/**
* Gets and sets the text shown to user at signing time.
*/
setInstructions(value) {
}
}
/**
* summary description of Slicer View
* @hideconstructor
*/
class Slicer {
/**
* Specifies the title of the current Slicer object.
*/
getTitle() {
}
/**
* Specifies the title of the current Slicer object.
*/
setTitle(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Slicer object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Slicer object.
*/
setAlternativeText(value) {
}
/**
* Indicates whether the slicer object is printable.
*/
isPrintable() {
}
/**
* Indicates whether the slicer object is printable.
*/
setPrintable(value) {
}
/**
* Indicates whether the slicer shape is locked.
*/
isLocked() {
}
/**
* Indicates whether the slicer shape is locked.
*/
setLocked(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Indicates whether locking aspect ratio.
*/
getLockedAspectRatio() {
}
/**
* Indicates whether locking aspect ratio.
*/
setLockedAspectRatio(value) {
}
/**
* Indicates whether the specified slicer can be moved or resized by using the user interface.
*/
getLockedPosition() {
}
/**
* Indicates whether the specified slicer can be moved or resized by using the user interface.
*/
setLockedPosition(value) {
}
/**
* Returns the SlicerCache object associated with the slicer. Read-only.
*/
getSlicerCache() {
}
/**
* Returns the Worksheet object that represents the sheet that contains the slicer. Read-only.
*/
getParent() {
}
/**
* Specify the type of Built-in slicer style
* the default type is SlicerStyleLight1
* The value of the property is SlicerStyleType integer constant.
*/
getStyleType() {
}
/**
* Specify the type of Built-in slicer style
* the default type is SlicerStyleLight1
* The value of the property is SlicerStyleType integer constant.
*/
setStyleType(value) {
}
/**
* Returns or sets the name of the specified slicer
*/
getName() {
}
/**
* Returns or sets the name of the specified slicer
*/
setName(value) {
}
/**
* Returns or sets the caption of the specified slicer.
*/
getCaption() {
}
/**
* Returns or sets the caption of the specified slicer.
*/
setCaption(value) {
}
/**
* Returns or sets whether the header that displays the slicer Caption is visible
* the default value is true
*/
getCaptionVisible() {
}
/**
* Returns or sets whether the header that displays the slicer Caption is visible
* the default value is true
*/
setCaptionVisible(value) {
}
/**
* Returns or sets the number of columns in the specified slicer.
*/
getNumberOfColumns() {
}
/**
* Returns or sets the number of columns in the specified slicer.
*/
setNumberOfColumns(value) {
}
/**
* Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
*/
getLeftPixel() {
}
/**
* Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
*/
setLeftPixel(value) {
}
/**
* Returns or sets the vertical offset of slicer shape from its top row, in pixels.
*/
getTopPixel() {
}
/**
* Returns or sets the vertical offset of slicer shape from its top row, in pixels.
*/
setTopPixel(value) {
}
/**
* Returns or sets the width of the specified slicer, in points.
*/
getWidth() {
}
/**
* Returns or sets the width of the specified slicer, in points.
*/
setWidth(value) {
}
/**
* Returns or sets the width of the specified slicer, in pixels.
*/
getWidthPixel() {
}
/**
* Returns or sets the width of the specified slicer, in pixels.
*/
setWidthPixel(value) {
}
/**
* Returns or sets the height of the specified slicer, in points.
*/
getHeight() {
}
/**
* Returns or sets the height of the specified slicer, in points.
*/
setHeight(value) {
}
/**
* Returns or sets the height of the specified slicer, in pixels.
*/
getHeightPixel() {
}
/**
* Returns or sets the height of the specified slicer, in pixels.
*/
setHeightPixel(value) {
}
/**
* Gets or sets the width in unit of pixels for each column of the slicer.
*/
getColumnWidthPixel() {
}
/**
* Gets or sets the width in unit of pixels for each column of the slicer.
*/
setColumnWidthPixel(value) {
}
/**
* Returns or sets the width, in points, of each column in the slicer.
*/
getColumnWidth() {
}
/**
* Returns or sets the width, in points, of each column in the slicer.
*/
setColumnWidth(value) {
}
/**
* Returns or sets the height, in pixels, of each row in the specified slicer.
*/
getRowHeightPixel() {
}
/**
* Returns or sets the height, in pixels, of each row in the specified slicer.
*/
setRowHeightPixel(value) {
}
/**
* Returns or sets the height, in points, of each row in the specified slicer.
*/
getRowHeight() {
}
/**
* Returns or sets the height, in points, of each row in the specified slicer.
*/
setRowHeight(value) {
}
/**
* Adds PivotTable connection.
* @param {PivotTable} pivot - The PivotTable object
*/
addPivotConnection(pivot) {
}
/**
* Removes PivotTable connection.
* @param {PivotTable} pivot - The PivotTable object
*/
removePivotConnection(pivot) {
}
/**
* Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.
*/
refresh() {
}
}
/**
* summary description of slicer cache
* @hideconstructor
*/
class SlicerCache {
/**
* Returns or sets whether a slicer is participating in cross filtering with other slicers
* that share the same slicer cache, and how cross filtering is displayed. Read/write
* The value of the property is SlicerCacheCrossFilterType integer constant.
*/
getCrossFilterType() {
}
/**
* Returns or sets whether a slicer is participating in cross filtering with other slicers
* that share the same slicer cache, and how cross filtering is displayed. Read/write
* The value of the property is SlicerCacheCrossFilterType integer constant.
*/
setCrossFilterType(value) {
}
/**
* Returns whether the slicer associated with the specified slicer cache is based on an Non-OLAP data source. Read-only
*/
getList() {
}
/**
* Returns a SlicerCacheItem collection that contains the collection of all items in the slicer cache. Read-only
*/
getSlicerCacheItems() {
}
/**
* Returns the name of the slicer cache.
*/
getName() {
}
/**
* Returns the name of cache field
*/
getSourceName() {
}
}
/**
* Represent slicer data source item
* @hideconstructor
*/
class SlicerCacheItem {
/**
* Specifies whether the SlicerItem is selected or not.
*/
getSelected() {
}
/**
* Specifies whether the SlicerItem is selected or not.
*/
setSelected(value) {
}
/**
* Returns the label text for the slicer item. Read-only.
*/
getValue() {
}
}
/**
* Represent the collection of SlicerCacheItem
* @hideconstructor
*/
class SlicerCacheItemCollection {
/**
* Gets the count of the SlicerCacheItem.
*/
getCount() {
}
/**
* Gets the SlicerCacheItem object by index.
*/
get(index) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Specifies the collection of all the Slicer objects on the specified worksheet.
* @hideconstructor
*/
class SlicerCollection {
/**
*/
getCount() {
}
/**
* Gets the Slicer by index.
*/
get(index) {
}
/**
* Gets the Slicer by slicer's name.
*/
get(name) {
}
/**
* Remove the specified Slicer
* @param {Slicer} slicer - The Slicer object
*/
remove(slicer) {
}
/**
* Deletes the Slicer at the specified index
* @param {Number} index - The position index in Slicer collection
*/
removeAt(index) {
}
/**
* Add a new Slicer using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {String} destCellName - The cell in the upper-left corner of the Slicer range.
* @param {String} baseFieldName - The name of PivotField in PivotTable.BaseFields
* @return {Number} The new add Slicer index
*/
add(pivot, destCellName, baseFieldName) {
}
/**
* Add a new Slicer using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {Number} row - Row index of the cell in the upper-left corner of the Slicer range.
* @param {Number} column - Column index of the cell in the upper-left corner of the Slicer range.
* @param {String} baseFieldName - The name of PivotField in PivotTable.BaseFields
* @return {Number} The new add Slicer index
*/
add(pivot, row, column, baseFieldName) {
}
/**
* Add a new Slicer using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {Number} row - Row index of the cell in the upper-left corner of the Slicer range.
* @param {Number} column - Column index of the cell in the upper-left corner of the Slicer range.
* @param {Number} baseFieldIndex - The index of PivotField in PivotTable.BaseFields
* @return {Number} The new add Slicer index
*/
add(pivot, row, column, baseFieldIndex) {
}
/**
* Add a new Slicer using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {String} destCellName - The cell in the upper-left corner of the Slicer range.
* @param {Number} baseFieldIndex - The index of PivotField in PivotTable.BaseFields
* @return {Number} The new add Slicer index
*/
add(pivot, destCellName, baseFieldIndex) {
}
/**
* Add a new Slicer using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {Number} row - Row index of the cell in the upper-left corner of the Slicer range.
* @param {Number} column - Column index of the cell in the upper-left corner of the Slicer range.
* @param {PivotField} baseField - The PivotField in PivotTable.BaseFields
* @return {Number} The new add Slicer index
*/
add(pivot, row, column, baseField) {
}
/**
* Add a new Slicer using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {String} destCellName - The cell in the upper-left corner of the Slicer range.
* @param {PivotField} baseField - The PivotField in PivotTable.BaseFields
* @return {Number} The new add Slicer index
*/
add(pivot, destCellName, baseField) {
}
/**
* Add a new Slicer using ListObjet as data source
* @param {ListObject} table - ListObject object
* @param {Number} index - The index of ListColumn in ListObject.ListColumns
* @param {String} destCellName - The cell in the upper-left corner of the Slicer range.
* @return {Number} The new add Slicer index
*/
add(table, index, destCellName) {
}
/**
* Add a new Slicer using ListObjet as data source
* @param {ListObject} table - ListObject object
* @param {ListColumn} listColumn - The ListColumn in ListObject.ListColumns
* @param {String} destCellName - The cell in the upper-left corner of the Slicer range.
* @return {Number} The new add Slicer index
*/
add(table, listColumn, destCellName) {
}
/**
* Add a new Slicer using ListObjet as data source
* @param {ListObject} table - ListObject object
* @param {ListColumn} listColumn - The ListColumn in ListObject.ListColumns
* @param {Number} row - Row index of the cell in the upper-left corner of the Slicer range.
* @param {Number} column - Column index of the cell in the upper-left corner of the Slicer range.
* @return {Number} The new add Slicer index
*/
add(table, listColumn, row, column) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the smart art.
* @hideconstructor
*/
class SmartArtShape {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the ActiveX control.
*/
getActiveXControl() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Creates the shape image and saves it to a stream in the specified format.
* The following formats are supported:
* .bmp, .gif, .jpg, .jpeg, .tiff, .emf.
* @param {OutputStream} stream - The output stream.
* @param {ImageFormat} imageFormat - The format in which to save the image.
*/
toImage(stream, imageFormat) {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Saves the shape to a stream.
*/
toImage(stream, options) {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a smart tag.
* @hideconstructor
*/
class SmartTag {
/**
* Indicates whether the smart tag is deleted.
*/
getDeleted() {
}
/**
* Indicates whether the smart tag is deleted.
*/
setDeleted(value) {
}
/**
* Gets and set the properties of the smart tag.
*/
getProperties() {
}
/**
* Gets and set the properties of the smart tag.
*/
setProperties(value) {
}
/**
* Gets the namespace URI of the smart tag.
*/
getUri() {
}
/**
* Gets the name of the smart tag.
*/
getName() {
}
/**
* Change the name and the namespace URI of the smart tag.
* @param {String} uri - The namespace URI of the smart tag.
* @param {String} name - The name of the smart tag.
*/
setLink(uri, name) {
}
}
/**
* Represents all smart tags in the cell.
* @hideconstructor
*/
class SmartTagCollection {
/**
* Gets the row of the cell smart tags.
*/
getRow() {
}
/**
* Gets the column of the cell smart tags.
*/
getColumn() {
}
/**
*/
getCount() {
}
/**
* Gets a SmartTag object at the specific index
* @param {Number} index - The index.
* @return {SmartTag} returns a SmartTag object.
*/
get(index) {
}
/**
* Adds a smart tag.
* @param {String} uri - Specifies the namespace URI of the smart tag
* @param {String} name - Specifies the name of the smart tag.
* @return {Number} The index of smart tag in the list.
*/
add(uri, name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the options of the smart tag.
*/
class SmartTagOptions {
/**
*/
constructor() {
}
/**
* Indicates whether saving smart tags with the workbook.
*/
getEmbedSmartTags() {
}
/**
* Indicates whether saving smart tags with the workbook.
*/
setEmbedSmartTags(value) {
}
/**
* Represents the show type of smart tag.
* The value of the property is SmartTagShowType integer constant.
*/
getShowType() {
}
/**
* Represents the show type of smart tag.
* The value of the property is SmartTagShowType integer constant.
*/
setShowType(value) {
}
}
/**
* Represents the property of the cell smart tag.
* @hideconstructor
*/
class SmartTagProperty {
/**
* Gets and sets the name of the property.
*/
getName() {
}
/**
* Gets and sets the name of the property.
*/
setName(value) {
}
/**
* Gets and sets the value of the property.
*/
getValue() {
}
/**
* Gets and sets the value of the property.
*/
setValue(value) {
}
}
/**
* Represents all properties of cell smart tag.
*/
class SmartTagPropertyCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets a SmartTagProperty object.
* @param {Number} index - The index
* @return {SmartTagProperty} Returns a SmartTagProperty object.
*/
get(index) {
}
/**
* Gets a SmartTagProperty object by the name of the property.
* @param {String} name - The name of the property.
* @return {SmartTagProperty} Returns a SmartTagProperty object.
*/
get(name) {
}
/**
* Adds a property of cell's smart tag.
* @param {String} name - The name of the property
* @param {String} value - The value of the property.
* @return {Number} return SmartTagProperty
*/
add(name, value) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents all SmartTagCollection object in the worksheet.
* @hideconstructor
*/
class SmartTagSetting {
/**
*/
getCount() {
}
/**
* Gets a SmartTagCollection object by the index.
* @param {Number} index - The index of the
* @return {SmartTagCollection}
*/
get(index) {
}
/**
* Gets the SmartTagCollection object of the cell.
* @param {Number} row - The row index of the cell.
* @param {Number} column - The column index of the cell
* @return {SmartTagCollection} Returns the SmartTagCollection object of the cell.
* Returns null if there is no any smart tags on the cell.
*/
get(row, column) {
}
/**
* Gets the SmartTagCollection object of the cell.
* @param {String} cellName - The name of the cell.
* @return {SmartTagCollection} Returns the SmartTagCollection object of the cell.
* Returns null if there is no any smart tags on the cell.
*/
get(cellName) {
}
/**
* Adds a SmartTagCollection object to a cell.
* @param {Number} row - The row of the cell.
* @param {Number} column - The column of the cell.
* @return {Number} Returns index of a SmartTagCollection object in the worksheet.
*/
add(row, column) {
}
/**
* Add a cell smart tags.
* @param {String} cellName - The name of the cell.
* @return {Number}
*/
add(cellName) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Encapsulates the object that represents solid fill format
* @hideconstructor
*/
class SolidFill {
/**
* Gets or sets the com.aspose.cells.Color.
*/
getColor() {
}
/**
* Gets or sets the com.aspose.cells.Color.
*/
setColor(value) {
}
/**
* Gets and sets the CellsColor object.
*/
getCellsColor() {
}
/**
* Gets and sets the CellsColor object.
*/
setCellsColor(value) {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
/**
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
}
/**
* A sparkline represents a tiny chart or graphic in a worksheet cell that provides a visual representation of data.
* @hideconstructor
*/
class Sparkline {
/**
* Represents the data range of the sparkline.
*/
getDataRange() {
}
/**
* Represents the data range of the sparkline.
*/
setDataRange(value) {
}
/**
* Gets the row index of the sparkline.
*/
getRow() {
}
/**
* Gets the column index of the sparkline.
*/
getColumn() {
}
/**
* Converts a sparkline to an image.
* @param {String} fileName - The image file name.
* @param {ImageOrPrintOptions} options - The image options
*/
toImage(fileName, options) {
}
/**
* Converts a sparkline to an image.
* @param {OutputStream} stream - The image stream.
* @param {ImageOrPrintOptions} options - The image options.
*/
toImage(stream, options) {
}
/**
* Converts a sparkline to an image.
* @param {Sparkline} sparkline - The Sparkline object
* @param {WritableStream} stream - The stream of the output image
* @param {ImageOrPrintOptions} options - Addtional image creation options
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("sparkline.xlsx");
* var sparkline = workbook.getWorksheets().get(0).getSparklineGroupCollection().get(0).getSparklineCollection().get(0);
* var imgWriteStream = fs.createWriteStream("sparkline.jpeg");
* var imgOptions = new aspose.cells.ImageOrPrintOptions();
* imgOptions.setHorizontalResolution(200);
* imgOptions.setVerticalResolution(300);
* imgOptions.setImageFormat(aspose.cells.ImageFormat.getJpeg());
* aspose.cells.Sparkline.toImageStream(sparkline, imgWriteStream, imgOptions);
*/
static toImageStream(sparkline, stream, options) {
}
}
/**
* Encapsulates a collection of Sparkline objects.
* @hideconstructor
*/
class SparklineCollection {
/**
*/
getCount() {
}
/**
* Gets the Sparkline element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Sparkline} The element at the specified index.
*/
get(index) {
}
/**
* Add a sparkline.
* @param {String} dataRange - Specifies the new data range of the sparkline.
* @param {Number} row - The row index of the location.
* @param {Number} column - The column index of the location.
*/
add(dataRange, row, column) {
}
/**
* Removes the sparkline
* @param {Object} o
*/
remove(o) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Sparkline is organized into 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.
* @hideconstructor
*/
class SparklineGroup {
/**
* Gets and sets the preset style type of the sparkline group.
* The value of the property is SparklinePresetStyleType integer constant.
*/
getPresetStyle() {
}
/**
* Gets and sets the preset style type of the sparkline group.
* The value of the property is SparklinePresetStyleType integer constant.
*/
setPresetStyle(value) {
}
/**
* Gets the collection of Sparkline object.
* NOTE: This member is now obsolete. Instead, please use SparklineGroup.Sparklines property.
* This property will be removed 12 months later since November 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSparklineCollection() {
}
/**
* Gets the collection of Sparkline object.
*/
getSparklines() {
}
/**
* Indicates the sparkline type of the sparkline group.
* The value of the property is SparklineType integer constant.
*/
getType() {
}
/**
* Indicates the sparkline type of the sparkline group.
* The value of the property is SparklineType integer constant.
*/
setType(value) {
}
/**
* Indicates how to plot empty cells.
* The value of the property is PlotEmptyCellsType integer constant.
*/
getPlotEmptyCellsType() {
}
/**
* Indicates how to plot empty cells.
* The value of the property is PlotEmptyCellsType integer constant.
*/
setPlotEmptyCellsType(value) {
}
/**
* Indicates whether to show data in hidden rows and columns.
*/
getDisplayHidden() {
}
/**
* Indicates whether to show data in hidden rows and columns.
*/
setDisplayHidden(value) {
}
/**
* Indicates whether to highlight the highest points of data in the sparkline group.
*/
getShowHighPoint() {
}
/**
* Indicates whether to highlight the highest points of data in the sparkline group.
*/
setShowHighPoint(value) {
}
/**
* Gets and sets the color of the highest points of data in the sparkline group.
*/
getHighPointColor() {
}
/**
* Gets and sets the color of the highest points of data in the sparkline group.
*/
setHighPointColor(value) {
}
/**
* Indicates whether to highlight the lowest points of data in the sparkline group.
*/
getShowLowPoint() {
}
/**
* Indicates whether to highlight the lowest points of data in the sparkline group.
*/
setShowLowPoint(value) {
}
/**
* Gets and sets the color of the lowest points of data in the sparkline group.
*/
getLowPointColor() {
}
/**
* Gets and sets the color of the lowest points of data in the sparkline group.
*/
setLowPointColor(value) {
}
/**
* Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
*/
getShowNegativePoints() {
}
/**
* Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
*/
setShowNegativePoints(value) {
}
/**
* Gets and sets the color of the negative values on the sparkline group.
*/
getNegativePointsColor() {
}
/**
* Gets and sets the color of the negative values on the sparkline group.
*/
setNegativePointsColor(value) {
}
/**
* Indicates whether to highlight the first point of data in the sparkline group.
*/
getShowFirstPoint() {
}
/**
* Indicates whether to highlight the first point of data in the sparkline group.
*/
setShowFirstPoint(value) {
}
/**
* Gets and sets the color of the first point of data in the sparkline group.
*/
getFirstPointColor() {
}
/**
* Gets and sets the color of the first point of data in the sparkline group.
*/
setFirstPointColor(value) {
}
/**
* Indicates whether to highlight the last point of data in the sparkline group.
*/
getShowLastPoint() {
}
/**
* Indicates whether to highlight the last point of data in the sparkline group.
*/
setShowLastPoint(value) {
}
/**
* Gets and sets the color of the last point of data in the sparkline group.
*/
getLastPointColor() {
}
/**
* Gets and sets the color of the last point of data in the sparkline group.
*/
setLastPointColor(value) {
}
/**
* Indicates whether to highlight each point in each line sparkline in the sparkline group.
*/
getShowMarkers() {
}
/**
* Indicates whether to highlight each point in each line sparkline in the sparkline group.
*/
setShowMarkers(value) {
}
/**
* Gets and sets the color of points in each line sparkline in the sparkline group.
*/
getMarkersColor() {
}
/**
* Gets and sets the color of points in each line sparkline in the sparkline group.
*/
setMarkersColor(value) {
}
/**
* Gets and sets the color of the sparklines in the sparkline group.
*/
getSeriesColor() {
}
/**
* Gets and sets the color of the sparklines in the sparkline group.
*/
setSeriesColor(value) {
}
/**
* Indicates whether the plot data is right to left.
*/
getPlotRightToLeft() {
}
/**
* Indicates whether the plot data is right to left.
*/
setPlotRightToLeft(value) {
}
/**
* Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
*/
getLineWeight() {
}
/**
* Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
*/
setLineWeight(value) {
}
/**
* Gets and sets the color of the horizontal axis in the sparkline group.
*/
getHorizontalAxisColor() {
}
/**
* Gets and sets the color of the horizontal axis in the sparkline group.
*/
setHorizontalAxisColor(value) {
}
/**
* Indicates whether to show the sparkline horizontal axis.
* The horizontal axis appears if the sparkline has data that crosses the zero axis.
*/
getShowHorizontalAxis() {
}
/**
* Indicates whether to show the sparkline horizontal axis.
* The horizontal axis appears if the sparkline has data that crosses the zero axis.
*/
setShowHorizontalAxis(value) {
}
/**
* Represents the range that contains the date values for the sparkline data.
*/
getHorizontalAxisDateRange() {
}
/**
* Represents the range that contains the date values for the sparkline data.
*/
setHorizontalAxisDateRange(value) {
}
/**
* Represents the vertical axis maximum value type.
* The value of the property is SparklineAxisMinMaxType integer constant.
*/
getVerticalAxisMaxValueType() {
}
/**
* Represents the vertical axis maximum value type.
* The value of the property is SparklineAxisMinMaxType integer constant.
*/
setVerticalAxisMaxValueType(value) {
}
/**
* Gets and sets the custom maximum value for the vertical axis.
*/
getVerticalAxisMaxValue() {
}
/**
* Gets and sets the custom maximum value for the vertical axis.
*/
setVerticalAxisMaxValue(value) {
}
/**
* Represents the vertical axis minimum value type.
* The value of the property is SparklineAxisMinMaxType integer constant.
*/
getVerticalAxisMinValueType() {
}
/**
* Represents the vertical axis minimum value type.
* The value of the property is SparklineAxisMinMaxType integer constant.
*/
setVerticalAxisMinValueType(value) {
}
/**
* Gets and sets the custom minimum value for the vertical axis.
*/
getVerticalAxisMinValue() {
}
/**
* Gets and sets the custom minimum value for the vertical axis.
*/
setVerticalAxisMinValue(value) {
}
/**
* 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 {String} dataRange - Specifies the new data range of the sparkline group.
* @param {boolean} isVertical - Specifies whether to plot the sparklines from the new data range by row or by column.
* @param {CellArea} locationRange - Specifies where the sparklines to be placed.
*/
resetRanges(dataRange, isVertical, locationRange) {
}
}
/**
* Encapsulates a collection of SparklineGroup objects.
* @hideconstructor
*/
class SparklineGroupCollection {
/**
*/
getCount() {
}
/**
* Gets the SparklineGroup element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {SparklineGroup} The element at the specified index.
*/
get(index) {
}
/**
* Adds an SparklineGroup item to the collection.
* @param {Number} type - SparklineType
* @param {String} dataRange - Specifies the data range of the sparkline group.
* @param {boolean} isVertical - Specifies whether to plot the sparklines from the data range by row or by column.
* @param {CellArea} locationRange - Specifies where the sparklines to be placed.
* @return {Number} SparklineGroup object index.
*/
add(type, dataRange, isVertical, locationRange) {
}
/**
* Clears the sparklines that is inside an area of cells.
* @param {CellArea} cellArea - Specifies the area of cells
*/
clearSparklines(cellArea) {
}
/**
* Clears the sparkline groups that overlaps an area of cells.
* @param {CellArea} cellArea - Specifies the area of cells
*/
clearSparklineGroups(cellArea) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the SpinButton control.
* @hideconstructor
*/
class SpinButtonActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and sets the minimum acceptable value.
*/
getMin() {
}
/**
* Gets and sets the minimum acceptable value.
*/
setMin(value) {
}
/**
* Gets and sets the maximum acceptable value.
*/
getMax() {
}
/**
* Gets and sets the maximum acceptable value.
*/
setMax(value) {
}
/**
* Gets and sets the value.
*/
getPosition() {
}
/**
* Gets and sets the value.
*/
setPosition(value) {
}
/**
* Gets and sets the amount by which the Position property changes
*/
getSmallChange() {
}
/**
* Gets and sets the amount by which the Position property changes
*/
setSmallChange(value) {
}
/**
* Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
* The value of the property is ControlScrollOrientation integer constant.
*/
getOrientation() {
}
/**
* Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
* The value of the property is ControlScrollOrientation integer constant.
*/
setOrientation(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Represents the Forms control: Spinner.
* Scroll value must be between 0 and 30000.
* @hideconstructor
*/
class Spinner {
/**
* Gets or sets the current value.
*/
getCurrentValue() {
}
/**
* Gets or sets the current value.
*/
setCurrentValue(value) {
}
/**
* Gets or sets the minimum value of a scroll bar or spinner range.
*/
getMin() {
}
/**
* Gets or sets the minimum value of a scroll bar or spinner range.
*/
setMin(value) {
}
/**
* Gets or sets the maximum value of a scroll bar or spinner range.
*/
getMax() {
}
/**
* Gets or sets the maximum value of a scroll bar or spinner range.
*/
setMax(value) {
}
/**
* Gets or sets the amount that the scroll bar or spinner is incremented a line scroll.
*/
getIncrementalChange() {
}
/**
* Gets or sets the amount that the scroll bar or spinner is incremented a line scroll.
*/
setIncrementalChange(value) {
}
/**
* Indicates whether the shape has 3-D shading.
*/
getShadow() {
}
/**
* Indicates whether the shape has 3-D shading.
*/
setShadow(value) {
}
/**
* Indicates whether this is a horizontal scroll bar.
*/
isHorizontal() {
}
/**
* Indicates whether this is a horizontal scroll bar.
*/
setHorizontal(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents the options for saving Excel 2003 spreadml file.
*/
class SpreadsheetML2003SaveOptions {
/**
* Creates the options for saving Excel 2003 spreadml file.
*/
constructor() {
}
/**
* Creates the options for saving Excel 2003 spreadml file.
* NOTE: This constructor is now obsolete.
* Instead, please use SpreadsheetML2003SaveOptions() constructor.
* This property will be removed 12 months later since January 2021.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Causes child elements to be indented.
* The default value is true.
* If the value is false, it will reduce the size of the xml file
*/
isIndentedFormatting() {
}
/**
* Causes child elements to be indented.
* The default value is true.
* If the value is false, it will reduce the size of the xml file
*/
setIndentedFormatting(value) {
}
/**
* Limit as xls, the max row index is 65535 and the max column index is 255.
*/
getLimitAsXls() {
}
/**
* Limit as xls, the max row index is 65535 and the max column index is 255.
*/
setLimitAsXls(value) {
}
/**
* The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell.
*/
getExportColumnIndexOfCell() {
}
/**
* The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell.
*/
setExportColumnIndexOfCell(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents column type map.
*/
class SqlScriptColumnTypeMap {
/**
*/
constructor() {
}
/**
* Gets string type in the database.
* @return {String}
*/
getStringType() {
}
/**
* Gets numeric type in the database.
* @return {String}
*/
getNumbericType() {
}
}
/**
* Represents the options of saving sql.
*/
class SqlScriptSaveOptions {
/**
* Creates options for saving sql file.
*/
constructor() {
}
/**
* Check if the table name exists before creating
*/
getCheckIfTableExists() {
}
/**
* Check if the table name exists before creating
*/
setCheckIfTableExists(value) {
}
/**
* Gets and sets the map of column type for different database.
*/
getColumnTypeMap() {
}
/**
* Gets and sets the map of column type for different database.
*/
setColumnTypeMap(value) {
}
/**
* Check all data to find columns' data type.
* 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() {
}
/**
* Check all data to find columns' data type.
* 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) {
}
/**
* Insert blank line between each data.
* If Separator is '\n' , it's better to set this property as true to increase readability.
*/
getAddBlankLineBetweenRows() {
}
/**
* Insert blank line between each data.
* If Separator is '\n' , it's better to set this property as true to increase readability.
*/
setAddBlankLineBetweenRows(value) {
}
/**
* Gets and sets character separator of sql script.
* Only can be ' ' or '\n'.
* If the
*/
getSeparator() {
}
/**
* Gets and sets character separator of sql script.
* Only can be ' ' or '\n'.
* If the
*/
setSeparator(value) {
}
/**
* Gets and sets the operator type of sql.
* The value of the property is SqlScriptOperatorType integer constant.
*/
getOperatorType() {
}
/**
* Gets and sets the operator type of sql.
* The value of the property is SqlScriptOperatorType integer constant.
*/
setOperatorType(value) {
}
/**
* Represents which column is primary key of the data table.
*/
getPrimaryKey() {
}
/**
* Represents which column is primary key of the data table.
*/
setPrimaryKey(value) {
}
/**
* Indicates whether exporting sql of creating table.
*/
getCreateTable() {
}
/**
* Indicates whether exporting sql of creating table.
*/
setCreateTable(value) {
}
/**
* Gets and sets the name of id column.
* If this property is set , a column will be inserted with automatical increment int value.
*/
getIdName() {
}
/**
* Gets and sets the name of id column.
* If this property is set , a column will be inserted with automatical increment int value.
*/
setIdName(value) {
}
/**
* Gets and sets the start id.
* Only works when IdName is set.
*/
getStartId() {
}
/**
* Gets and sets the start id.
* Only works when IdName is set.
*/
setStartId(value) {
}
/**
* Gets and sets the table name.
*/
getTableName() {
}
/**
* Gets and sets the table name.
*/
setTableName(value) {
}
/**
* Indicates whether exporting all data as string value.
*/
getExportAsString() {
}
/**
* Indicates whether exporting all data as string value.
*/
setExportAsString(value) {
}
/**
* Represents the indexes of exported sheets.
*/
getSheetIndexes() {
}
/**
* Represents the indexes of exported sheets.
*/
setSheetIndexes(value) {
}
/**
* Gets or sets the exporting range.
*/
getExportArea() {
}
/**
* Gets or sets the exporting range.
*/
setExportArea(value) {
}
/**
* Indicates whether the range contains header row.
*/
hasHeaderRow() {
}
/**
* Indicates whether the range contains header row.
*/
setHasHeaderRow(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents display style of excel document,such as font,color,alignment,border,etc.
* The Style object contains all style attributes (font, number format, alignment, and so on) as properties.
* @example
* //First method
* var excel = new aspose.cells.Workbook();
* var style = excel.createStyle();
* style.getFont().setName("Times New Roman");
* style.getFont().setColor(aspose.cells.Color.getBlue());
* for (var i = 0; i < 100; i++)
* {
* excel.getWorksheets().get(0).getCells().get(0, i).setStyle(style);
* }
* //Second method
* var style1 = excel.getWorksheets().get(0).getCells().get("A1").getStyle();
* style1.getFont().setName("Times New Roman");
* style1.getFont().setColor(aspose.cells.Color.getBlue());
* excel.getWorksheets().get(0).getCells().get("A1").setStyle(style1);
* //First method is a fast and efficient way to change several cell-formatting properties on multiple cells at the same time.
* //If you want to change a single cell's style properties, second method can be used.
*/
class Style {
/**
* Initializes a new instance of the Style class.
* NOTE: This constructor is now obsolete.
* Instead, please use CellsFactory.CreateStyle() method.
* This property will be removed 6 months later since October 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
constructor() {
}
/**
* Gets and sets the background theme color.
* If the background color is not a theme color, NULL will be returned.
*/
getBackgroundThemeColor() {
}
/**
* Gets and sets the background theme color.
* If the background color is not a theme color, NULL will be returned.
*/
setBackgroundThemeColor(value) {
}
/**
* Gets and sets the foreground theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
getForegroundThemeColor() {
}
/**
* Gets and sets the foreground theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
setForegroundThemeColor(value) {
}
/**
* Gets or sets the name of the style.
*/
getName() {
}
/**
* Gets or sets the name of the style.
*/
setName(value) {
}
/**
* Gets or sets the cell background pattern type.
* The value of the property is BackgroundType integer constant.
*/
getPattern() {
}
/**
* Gets or sets the cell background pattern type.
* The value of the property is BackgroundType integer constant.
*/
setPattern(value) {
}
/**
* Gets the BorderCollection of the style.
*/
getBorders() {
}
/**
* Gets or sets a style's background color.
* If you want to set a cell's color, please use Style.ForegroundColor property.
* Only if the cell style pattern is other than none or solid, this property will take effect.
*/
getBackgroundColor() {
}
/**
* Gets or sets a style's background color.
* If you want to set a cell's color, please use Style.ForegroundColor property.
* Only if the cell style pattern is other than none or solid, this property will take effect.
*/
setBackgroundColor(value) {
}
/**
* Gets and sets the background color with a 32-bit ARGB value.
*/
getBackgroundArgbColor() {
}
/**
* Gets and sets the background color with a 32-bit ARGB value.
*/
setBackgroundArgbColor(value) {
}
/**
* Gets or sets a style's foreground color.
* It means no color setting if Color.Empty is returned.
*/
getForegroundColor() {
}
/**
* Gets or sets a style's foreground color.
* It means no color setting if Color.Empty is returned.
*/
setForegroundColor(value) {
}
/**
* Gets and sets the foreground color with a 32-bit ARGB value.
*/
getForegroundArgbColor() {
}
/**
* Gets and sets the foreground color with a 32-bit ARGB value.
*/
setForegroundArgbColor(value) {
}
/**
* Checks whether there are borders have been set for the style.
*/
hasBorders() {
}
/**
* Gets the parent style of this style.
*/
getParentStyle() {
}
/**
* Indicate whether the number formatting should be applied.
* Only for named style.
*/
isNumberFormatApplied() {
}
/**
* Indicate whether the number formatting should be applied.
* Only for named style.
*/
setNumberFormatApplied(value) {
}
/**
* Indicate whether the font formatting should be applied.
* Only for named style.
*/
isFontApplied() {
}
/**
* Indicate whether the font formatting should be applied.
* Only for named style.
*/
setFontApplied(value) {
}
/**
* Indicate whether the alignment formatting should be applied.
* Only for named style.
*/
isAlignmentApplied() {
}
/**
* Indicate whether the alignment formatting should be applied.
* Only for named style.
*/
setAlignmentApplied(value) {
}
/**
* Indicate whether the border formatting should be applied.
* Only for named style.
*/
isBorderApplied() {
}
/**
* Indicate whether the border formatting should be applied.
* Only for named style.
*/
setBorderApplied(value) {
}
/**
* Indicate whether the fill formatting should be applied.
* Only for named style.
*/
isFillApplied() {
}
/**
* Indicate whether the fill formatting should be applied.
* Only for named style.
*/
setFillApplied(value) {
}
/**
* Indicate whether the protection formatting should be applied.
* Only for named style.
*/
isProtectionApplied() {
}
/**
* Indicate whether the protection formatting should be applied.
* Only for named style.
*/
setProtectionApplied(value) {
}
/**
* Represents the indent level for the cell or range. Can only be an integer from 0 to 250.
* If text horizontal alignment type is set to value other than left or right, indent level will
* be reset to zero.
*/
getIndentLevel() {
}
/**
* Represents the indent level for the cell or range. Can only be an integer from 0 to 250.
* If text horizontal alignment type is set to value other than left or right, indent level will
* be reset to zero.
*/
setIndentLevel(value) {
}
/**
* Gets a Font object.
*/
getFont() {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
* You can set 255 or value ranged from -90 to 90.
*/
getRotationAngle() {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
* You can set 255 or value ranged from -90 to 90.
*/
setRotationAngle(value) {
}
/**
* Gets or sets the horizontal alignment type of the text in a cell.
* The value of the property is TextAlignmentType integer constant.
*/
getHorizontalAlignment() {
}
/**
* Gets or sets the horizontal alignment type of the text in a cell.
* The value of the property is TextAlignmentType integer constant.
*/
setHorizontalAlignment(value) {
}
/**
* Gets or sets the vertical alignment type of the text in a cell.
* The value of the property is TextAlignmentType integer constant.
*/
getVerticalAlignment() {
}
/**
* Gets or sets the vertical alignment type of the text in a cell.
* The value of the property is TextAlignmentType integer constant.
*/
setVerticalAlignment(value) {
}
/**
* Gets or sets a value indicating whether the text within a cell is wrapped.
*/
isTextWrapped() {
}
/**
* Gets or sets a value indicating whether the text within a cell is wrapped.
*/
setTextWrapped(value) {
}
/**
* Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.
* For example, the formatting patterns represented by numbers for en_US region:
* ValueTypeFormat String0GeneralGeneral1Decimal02Decimal0.003Decimal#,##04Decimal#,##0.005Currency$#,##0_);($#,##0)6Currency$#,##0_);[Red]($#,##0)7Currency$#,##0.00_);($#,##0.00)8Currency$#,##0.00_);[Red]($#,##0.00)9Percentage0%10Percentage0.00%11Scientific0.00E+0012Fraction# ?/?13Fraction# ??/??14Datem/d/yyyy15Dated-mmm-yy16Dated-mmm17Datemmm-yy18Timeh:mm AM/PM19Timeh:mm:ss AM/PM20Timeh:mm21Timeh:mm:ss22Timem/d/yyyy h:mm37Accounting#,##0_);(#,##0)38Accounting#,##0_);[Red](#,##0)39Accounting#,##0.00_);(#,##0.00)40Accounting#,##0.00_);[Red](#,##0.00)41Accounting_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)42Currency_($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)43Accounting_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)44Currency_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)45Timemm:ss46Time[h]:mm:ss47Timemm:ss.048Scientific##0.0E+049Text@
*/
getNumber() {
}
/**
* Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.
* For example, the formatting patterns represented by numbers for en_US region:
* ValueTypeFormat String0GeneralGeneral1Decimal02Decimal0.003Decimal#,##04Decimal#,##0.005Currency$#,##0_);($#,##0)6Currency$#,##0_);[Red]($#,##0)7Currency$#,##0.00_);($#,##0.00)8Currency$#,##0.00_);[Red]($#,##0.00)9Percentage0%10Percentage0.00%11Scientific0.00E+0012Fraction# ?/?13Fraction# ??/??14Datem/d/yyyy15Dated-mmm-yy16Dated-mmm17Datemmm-yy18Timeh:mm AM/PM19Timeh:mm:ss AM/PM20Timeh:mm21Timeh:mm:ss22Timem/d/yyyy h:mm37Accounting#,##0_);(#,##0)38Accounting#,##0_);[Red](#,##0)39Accounting#,##0.00_);(#,##0.00)40Accounting#,##0.00_);[Red](#,##0.00)41Accounting_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)42Currency_($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)43Accounting_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)44Currency_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)45Timemm:ss46Time[h]:mm:ss47Timemm:ss.048Scientific##0.0E+049Text@
*/
setNumber(value) {
}
/**
* Gets or sets a value indicating whether a cell can be modified or not.
* Locking cells has no effect unless the worksheet is protected.
*/
isLocked() {
}
/**
* Gets or sets a value indicating whether a cell can be modified or not.
* Locking cells has no effect unless the worksheet is protected.
*/
setLocked(value) {
}
/**
* Represents the custom number format string of this style object.
* If the custom number format is not set(For example, the number format is builtin), "" will be returned.
* The returned custom string is culture-independent.
*/
getCustom() {
}
/**
* Represents the custom number format string of this style object.
* If the custom number format is not set(For example, the number format is builtin), "" will be returned.
* The returned custom string is culture-independent.
*/
setCustom(value) {
}
/**
* Gets and sets the culture-dependent pattern string for number format.
* If no number format has been set for this object, null will be returned.
* If number format is builtin, the pattern string corresponding to the builtin number will be returned.
* For builtin number format, both the pattern content(such as, one builtin date format is "m/d/y" for some locales,
* but for some other locales it becomes "d/m/y") and the format specifier(such as,
* some locales is using character other than 'y' to represent the year part for date formatting)
* are culture-dependent;
* For user specified custom format, only format specifiers are changed according to the culture,
* other parts of the formatting pattern will not be modified.
*/
getCultureCustom() {
}
/**
* Gets and sets the culture-dependent pattern string for number format.
* If no number format has been set for this object, null will be returned.
* If number format is builtin, the pattern string corresponding to the builtin number will be returned.
* For builtin number format, both the pattern content(such as, one builtin date format is "m/d/y" for some locales,
* but for some other locales it becomes "d/m/y") and the format specifier(such as,
* some locales is using character other than 'y' to represent the year part for date formatting)
* are culture-dependent;
* For user specified custom format, only format specifiers are changed according to the culture,
* other parts of the formatting pattern will not be modified.
*/
setCultureCustom(value) {
}
/**
* Gets the culture-independent pattern string for number format.
* If no number format has been set for this object, null will be returned.
* If number format is builtin, the pattern string corresponding to the builtin number will be returned.
* For builtin number formats, the returned pattern content is still culture-dependent,
* such as, for some locales it returns "m/d/y" and for some other locales it returns "d/m/y".
* The difference from CultureCustom is(that is also what culture-independent means):
* the format specifiers and separators are kept as standard, such as '/' will always be used as datetime separator
* and "y" will always be used as the "year" part no matter what other special character is used for the specific locale.
*/
getInvariantCustom() {
}
/**
* Represents if the formula will be hidden when the worksheet is protected.
*/
isFormulaHidden() {
}
/**
* Represents if the formula will be hidden when the worksheet is protected.
*/
setFormulaHidden(value) {
}
/**
* Represents if text automatically shrinks to fit in the available column width.
*/
getShrinkToFit() {
}
/**
* Represents if text automatically shrinks to fit in the available column width.
*/
setShrinkToFit(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Indicates if the cells justified or distributed alignment should be used on the last line of text.
* This is typical for East Asian alignments but not typical in other contexts.
*/
isJustifyDistributed() {
}
/**
* Indicates if the cells justified or distributed alignment should be used on the last line of text.
* This is typical for East Asian alignments but not typical in other contexts.
*/
setJustifyDistributed(value) {
}
/**
* Indicates whether the cell's value starts with single quote mark.
*/
getQuotePrefix() {
}
/**
* Indicates whether the cell's value starts with single quote mark.
*/
setQuotePrefix(value) {
}
/**
* Indicates whether the cell shading is a gradient pattern.
*/
isGradient() {
}
/**
* Indicates whether the cell shading is a gradient pattern.
*/
setGradient(value) {
}
/**
* Indicates whether the number format is a percent format.
*/
isPercent() {
}
/**
* Indicates whether the number format is a date format.
*/
isDateTime() {
}
/**
* Sets the specified fill to a two-color gradient.
* @param {Color} color1 - One gradient color.
* @param {Color} color2 - Two gradient color.
* @param {Number} gradientStyleType - GradientStyleType
* @param {Number} 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, color2, gradientStyleType, variant) {
}
/**
* Get the two-color gradient setting.
* If this is not gradient fill,return null;
* NOTE: This method is now obsolete.
* Instead, please use Style.GetTwoColorGradientSetting() method.
* This property will be removed 12 months later since December 2022.
* Aspose apologizes for any inconvenience you may have experienced.@return {Object[]} Returns all setting about two-color gradient
* [0] : Color1
* [1] : Color2
* [2] : GradientStyleType
* [3] : Variant
*/
getTwoColorGradient() {
}
/**
* Get the two-color gradient setting.
*/
getTwoColorGradientSetting() {
}
/**
* Convert Style to JSON struct data.
* @return {String}
*/
toJson() {
}
/**
* Sets the background color.
* @param {Number} pattern - BackgroundType
* @param {Color} color1 - The foreground color.
* @param {Color} color2 - The background color. Only works when pattern is not BackgroundType.None and BackgroundType.Solid.
*/
setPatternColor(pattern, color1, color2) {
}
/**
* Copies data from another style object
* This method does not copy the name of the style.
* If you want to copy the name, please call the following codes after copying style:
* destStyle.Name = style.Name.
* @param {Style} style - Source Style object
*/
copy(style) {
}
/**
* Apply the named style to the styles of the cells which use this named style.
* It works like clicking the "ok" button after you finished modifying the style.
* Only applies for named style.
*/
update() {
}
/**
* Checks whether the specified properties of the style have been modified.
* Used for style of ConditionalFormattings to check whether the specified properties of this style should be used when applying the ConditionalFormattings on a cell.
* @param {Number} modifyFlag - StyleModifyFlag
* @return {boolean} true if the specified properties have been modified
*/
isModified(modifyFlag) {
}
/**
* Determines whether two Style instances are equal.
* @param {Object} obj - The Style object to compare with the current Style object.
* @return {boolean} true if the specified Object is equal to the current Object; otherwise, false.
*/
equals(obj) {
}
/**
* Serves as a hash function for a Style object.
* This method is only for internal use.@return {Number} A hash code for the current Object.
*/
hashCode() {
}
/**
* Sets the borders of the style.
* @param {Number} borderType - BorderType
* @param {Number} borderStyle - CellBorderType
* @param {Color} borderColor - The color of the border.
* @return {boolean} Whether current border settings have been changed.
*/
setBorder(borderType, borderStyle, borderColor) {
}
/**
* Sets the borders of the style.
* @param {Number} borderType - BorderType
* @param {Number} borderStyle - CellBorderType
* @param {CellsColor} borderColor - The color of the border.
* @return {boolean} Whether current border settings have been changed.
*/
setBorder(borderType, borderStyle, borderColor) {
}
/**
* Sets the Custom number format string of a cell.
* @param {String} custom - Custom number format string, should be InvariantCulture pattern.
* @param {boolean} builtinPreference - If given Custom number format string matches one of the built-in number formats
* corresponding to current regional settings, whether set the number format as built-in instead of Custom.
*/
setCustom(custom, builtinPreference) {
}
}
/**
* Represents flags which indicates applied formatting properties.
*/
class StyleFlag {
/**
* Constructs an object with all flags as false.
*/
constructor() {
}
/**
* All properties will be applied.
*/
getAll() {
}
/**
* All properties will be applied.
*/
setAll(value) {
}
/**
* All borders settings will be applied.
*/
getBorders() {
}
/**
* All borders settings will be applied.
*/
setBorders(value) {
}
/**
* Left border settings will be applied.
*/
getLeftBorder() {
}
/**
* Left border settings will be applied.
*/
setLeftBorder(value) {
}
/**
* Right border settings will be applied.
*/
getRightBorder() {
}
/**
* Right border settings will be applied.
*/
setRightBorder(value) {
}
/**
* Top border settings will be applied.
*/
getTopBorder() {
}
/**
* Top border settings will be applied.
*/
setTopBorder(value) {
}
/**
* Bottom border settings will be applied.
*/
getBottomBorder() {
}
/**
* Bottom border settings will be applied.
*/
setBottomBorder(value) {
}
/**
* Diagonal down border settings will be applied.
*/
getDiagonalDownBorder() {
}
/**
* Diagonal down border settings will be applied.
*/
setDiagonalDownBorder(value) {
}
/**
* Diagonal up border settings will be applied.
*/
getDiagonalUpBorder() {
}
/**
* Diagonal up border settings will be applied.
*/
setDiagonalUpBorder(value) {
}
/**
* Font settings will be applied.
*/
getFont() {
}
/**
* Font settings will be applied.
*/
setFont(value) {
}
/**
* Font size setting will be applied.
*/
getFontSize() {
}
/**
* Font size setting will be applied.
*/
setFontSize(value) {
}
/**
* Font name setting will be applied.
*/
getFontName() {
}
/**
* Font name setting will be applied.
*/
setFontName(value) {
}
/**
* Font color setting will be applied.
*/
getFontColor() {
}
/**
* Font color setting will be applied.
*/
setFontColor(value) {
}
/**
* Font bold setting will be applied.
*/
getFontBold() {
}
/**
* Font bold setting will be applied.
*/
setFontBold(value) {
}
/**
* Font italic setting will be applied.
*/
getFontItalic() {
}
/**
* Font italic setting will be applied.
*/
setFontItalic(value) {
}
/**
* Font underline setting will be applied.
*/
getFontUnderline() {
}
/**
* Font underline setting will be applied.
*/
setFontUnderline(value) {
}
/**
* Font strikeout setting will be applied.
*/
getFontStrike() {
}
/**
* Font strikeout setting will be applied.
*/
setFontStrike(value) {
}
/**
* Font script setting will be applied.
*/
getFontScript() {
}
/**
* Font script setting will be applied.
*/
setFontScript(value) {
}
/**
* Number format setting will be applied.
*/
getNumberFormat() {
}
/**
* Number format setting will be applied.
*/
setNumberFormat(value) {
}
/**
* Alignment setting will be applied.
*/
getAlignments() {
}
/**
* Alignment setting will be applied.
*/
setAlignments(value) {
}
/**
* Horizontal alignment setting will be applied.
*/
getHorizontalAlignment() {
}
/**
* Horizontal alignment setting will be applied.
*/
setHorizontalAlignment(value) {
}
/**
* Vertical alignment setting will be applied.
*/
getVerticalAlignment() {
}
/**
* Vertical alignment setting will be applied.
*/
setVerticalAlignment(value) {
}
/**
* Indent level setting will be applied.
*/
getIndent() {
}
/**
* Indent level setting will be applied.
*/
setIndent(value) {
}
/**
* Rotation setting will be applied.
*/
getRotation() {
}
/**
* Rotation setting will be applied.
*/
setRotation(value) {
}
/**
* Wrap text setting will be applied.
*/
getWrapText() {
}
/**
* Wrap text setting will be applied.
*/
setWrapText(value) {
}
/**
* Shrink to fit setting will be applied.
*/
getShrinkToFit() {
}
/**
* Shrink to fit setting will be applied.
*/
setShrinkToFit(value) {
}
/**
* Text direction setting will be applied.
*/
getTextDirection() {
}
/**
* Text direction setting will be applied.
*/
setTextDirection(value) {
}
/**
* Cell shading setting will be applied.
*/
getCellShading() {
}
/**
* Cell shading setting will be applied.
*/
setCellShading(value) {
}
/**
* Locked setting will be applied.
*/
getLocked() {
}
/**
* Locked setting will be applied.
*/
setLocked(value) {
}
/**
* Hide formula setting will be applied.
*/
getHideFormula() {
}
/**
* Hide formula setting will be applied.
*/
setHideFormula(value) {
}
/**
* Hide formula setting will be applied.
*/
getQuotePrefix() {
}
/**
* Hide formula setting will be applied.
*/
setQuotePrefix(value) {
}
}
/**
* 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.
* @hideconstructor
*/
class SubSupEquationNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents the setting of the subtotal .
* @hideconstructor
*/
class SubtotalSetting {
/**
* The field to group by, as a zero-based integer offset
*/
getGroupBy() {
}
/**
* The subtotal function.
* The value of the property is ConsolidationFunction integer constant.
*/
getSubtotalFunction() {
}
/**
* An array of zero-based field offsets, indicating the fields to which the subtotals are added.
*/
getTotalList() {
}
/**
* Indicates whether add summary below data.
*/
getSummaryBelowData() {
}
}
/**
* Represents Svg save options.
* For advanced usage, please use WorkbookRender or SheetRender.
* NOTE: This class is now obsolete.
* Instead, please use ImageSaveOptions class.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
class SvgSaveOptions {
/**
* Creates the options for saving svg file.
* NOTE: This class is now obsolete.
* Instead, please use ImageSaveOptions class.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
constructor() {
}
/**
* Creates the options for saving svg file.
* NOTE: This constructor is now obsolete.
* Instead, please use SvgSaveOptions() constructor.
* This property will be removed 12 months later since August 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Gets and sets which worksheet should be exported.
* If the value is -1, the active worksheet will be exported.
* NOTE: This class is now obsolete.
* Instead, please use ImageSaveOptions class.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSheetIndex() {
}
/**
* Gets and sets which worksheet should be exported.
* If the value is -1, the active worksheet will be exported.
* NOTE: This class is now obsolete.
* Instead, please use ImageSaveOptions class.
* This property will be removed 12 months later since March 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSheetIndex(value) {
}
/**
* Additional image creation options.
* For advanced usage, please use WorkbookRender or SheetRender.
*/
getImageOrPrintOptions() {
}
/**
* Gets or sets the IStreamProvider for exporting objects.
* If saving as Tiff, this property is ignored.
* Otherwise, if more than one image should be saving, we will write other images by this.
* For advanced usage, please use WorkbookRender or SheetRender.
*/
getStreamProvider() {
}
/**
* Gets or sets the IStreamProvider for exporting objects.
* If saving as Tiff, this property is ignored.
* Otherwise, if more than one image should be saving, we will write other images by this.
* For advanced usage, please use WorkbookRender or SheetRender.
*/
setStreamProvider(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents Group Range in a PivotField.
* NOTE: This class is now obsolete. Instead,
* please use PivotFieldGroupSettings class.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @hideconstructor
*/
class SxRng {
/**
* Specifies a boolean value that indicates whether the application will use the source data to set the beginning range value.
*/
isAutoStart() {
}
/**
* Specifies a boolean value that indicates whether the application will use the source data to set the end range value.
*/
isAutoEnd() {
}
/**
* Represents the start object for the group range.
*/
getStart() {
}
/**
* Represents the end object for the group range.
*/
getEnd() {
}
/**
* Represents the interval object for the group range.
*/
getBy() {
}
/**
* Represents the group type for the group range.
* rangeofvalue Seconds Minutes Hours Days Months Quarters Years
*/
getGroupByTypes() {
}
}
/**
* Simple implementation of AbstractInterruptMonitor by checking and comparing current system time with user specified limit.
* 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.
*/
class SystemTimeInterruptMonitor {
/**
* Constructs one interruption monitor.
* @param {boolean} terminateWithoutException - TerminateWithoutException
*/
constructor(terminateWithoutException) {
}
/**
* This implementation just checks whether the time cost(from the time when starting this monitor to now) is greater than user specified limit.
*/
isInterruptionRequested() {
}
/**
* See TerminateWithoutException.
* This property is specified by user when constructing this monitor instance.
*/
getTerminateWithoutException() {
}
/**
* 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 {Number} msLimit - time limit(ms) to require the interruption.
*/
startMonitor(msLimit) {
}
}
/**
* Represents the table style.
* @example
* var workbook = new aspose.cells.Workbook();
* var firstColumnStyle = workbook.createStyle();
* firstColumnStyle.setPattern(aspose.cells.BackgroundType.SOLID);
* firstColumnStyle.setBackgroundColor(aspose.cells.Color.getRed());
* var lastColumnStyle = workbook.createStyle();
* lastColumnStyle.getFont().setBold(true);
* lastColumnStyle.setPattern(aspose.cells.BackgroundType.SOLID);
* lastColumnStyle.setBackgroundColor(aspose.cells.Color.getRed());
* var tableStyleName = "Custom1";
* var tableStyles = workbook.getWorksheets().getTableStyles();
* var index1 = tableStyles.addTableStyle(tableStyleName);
* var tableStyle = tableStyles.get(index1);
* var elements = tableStyle.getTableStyleElements();
* index1 = elements.add(aspose.cells.TableStyleElementType.FIRST_COLUMN);
* var element = elements.get(index1);
* element.setElementStyle(firstColumnStyle);
* index1 = elements.add(aspose.cells.TableStyleElementType.LAST_COLUMN);
* element = elements.get(index1);
* element.setElementStyle(lastColumnStyle);
* var cells = workbook.getWorksheets().get(0).getCells();
* for (var i = 0; i < 5; i++)
* {
* cells.get(0, i).putValue(aspose.cells.CellsHelper.columnIndexToName(i));
* }
* for (var row = 1; row < 10; row++)
* {
* for (var column = 0; column < 5; column++)
* {
* cells.get(row, column).putValue(row * column);
* }
* }
* var tables = workbook.getWorksheets().get(0).getListObjects();
* var index = tables.add(0, 0, 9, 4, true);
* var table = tables.get(0);
* table.setShowTableStyleFirstColumn(true);
* table.setShowTableStyleLastColumn(true);
* table.setTableStyleName(tableStyleName);
* workbook.save("Book1.xlsx");
* @hideconstructor
*/
class TableStyle {
/**
* Gets the name of table style.
*/
getName() {
}
/**
* Gets all elements of the table style.
*/
getTableStyleElements() {
}
}
/**
* Represents all custom table styles.
* @hideconstructor
*/
class TableStyleCollection {
/**
* Gets and sets the default style name of the table.
*/
getDefaultTableStyleName() {
}
/**
* Gets and sets the default style name of the table.
*/
setDefaultTableStyleName(value) {
}
/**
* Gets and sets the default style name of pivot table .
*/
getDefaultPivotStyleName() {
}
/**
* Gets and sets the default style name of pivot table .
*/
setDefaultPivotStyleName(value) {
}
/**
*/
getCount() {
}
/**
* Gets the table style by the index.
* @param {Number} index - The position of the table style in the list.
* @return {TableStyle} The table style object.
*/
get(index) {
}
/**
* Gets the table style by the name.
* @param {String} name - The table style name.
* @return {TableStyle} The table style object.
*/
get(name) {
}
/**
* Adds a custom table style.
* @param {String} name - The table style name.
* @return {Number} The index of the table style.
*/
addTableStyle(name) {
}
/**
* Adds a custom pivot table style.
* @param {String} name - The pivot table style name.
* @return {Number} The index of the pivot table style.
*/
addPivotTableStyle(name) {
}
/**
* Gets the builtin table style
* @param {Number} type - TableStyleType
* @return {TableStyle}
*/
getBuiltinTableStyle(type) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the element of the table style.
* @hideconstructor
*/
class TableStyleElement {
/**
* Number of rows or columns in a single band of striping.
* Applies only when type is firstRowStripe, secondRowStripe, firstColumnStripe, or secondColumnStripe.
*/
getSize() {
}
/**
* Number of rows or columns in a single band of striping.
* Applies only when type is firstRowStripe, secondRowStripe, firstColumnStripe, or secondColumnStripe.
*/
setSize(value) {
}
/**
* Gets the element type.
* The value of the property is TableStyleElementType integer constant.
*/
getType() {
}
/**
* Gets the element style.
* @return {Style} Returns the Style object.
*/
getElementStyle() {
}
/**
* Sets the element style.
* @param {Style} style - The element style.
*/
setElementStyle(style) {
}
}
/**
* Represents all elements of the table style.
* @hideconstructor
*/
class TableStyleElementCollection {
/**
*/
getCount() {
}
/**
* Gets an element of the table style by the index.
* @param {Number} index - The index.
* @return {TableStyleElement} Returns TableStyleElement object
*/
get(index) {
}
/**
* Gets the element of the table style by the element type.
* @param {Number} type - TableStyleElementType
* @return {TableStyleElement} Returns TableStyleElement object
*/
getByTableStyleElementType(type) {
}
/**
* Gets an element of the table style by the index.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Tables.TableStyleElementCollection.this[int index] property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTableStyleElementWithIndex(index) {
}
/**
* Gets the element of the table style by the element type.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Tables.TableStyleElementCollection.this[TableStyleElementType type] property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTableStyleElementWithType(type) {
}
/**
* Adds an element.
* @param {Number} type - TableStyleElementType
* @return {Number} Returns the index of the element in the list.
*/
add(type) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the options when converting table to range.
*/
class TableToRangeOptions {
/**
*/
constructor() {
}
/**
* Gets and sets the last row index of the table.
*/
getLastRow() {
}
/**
* Gets and sets the last row index of the table.
*/
setLastRow(value) {
}
}
/**
* Encapsulates the object that represents a textbox in a spreadsheet.
* @example
* //Instantiate a new Workbook.
* var workbook = new aspose.cells.Workbook();
* //Get the first worksheet in the book.
* var worksheet = workbook.getWorksheets().get(0);
* //Add a new textbox to the collection.
* var textboxIndex = worksheet.getTextBoxes().add(2, 1, 160, 200);
* //Get the textbox object.
* var textbox0 = worksheet.getTextBoxes().get(textboxIndex);
* //Fill the text.
* textbox0.setText("ASPOSE______The .NET and JAVA Component Publisher!");
* //Get the textbox text frame.
* var textframe0 = textbox0.getTextFrame();
* //Set the textbox to adjust it according to its contents.
* textframe0.setAutoSize(true);
* //Set the placement.
* textbox0.setPlacement(aspose.cells.PlacementType.FREE_FLOATING);
* //Set the font color.
* textbox0.getFont().setColor(aspose.cells.Color.getBlue());
* //Set the font to bold.
* textbox0.getFont().setBold(true);
* //Set the font size.
* textbox0.getFont().setSize(14);
* //Set font attribute to italic.
* textbox0.getFont().setItalic(true);
* //Add a hyperlink to the textbox.
* textbox0.addHyperlink("http://www.aspose.com/");
* //Get the filformat of the textbox.
* var fillformat = textbox0.getFillFormat();
* //Set the fillcolor.
* fillformat.setForeColor(aspose.cells.Color.getSilver());
* //Get the lineformat type of the textbox.
* var lineformat = textbox0.getLineFormat();
* //Set the line style.
* lineformat.setStyle(aspose.cells.MsoLineStyle.THIN_THICK);
* //Set the line weight.
* lineformat.setWeight(6);
* //Set the dash style to squaredot.
* lineformat.setDashStyle(aspose.cells.MsoLineDashStyle.SQUARE_DOT);
* //Add another textbox.
* textboxIndex = worksheet.getTextBoxes().add(15, 4, 85, 120);
* //Get the second textbox.
* var textbox1 = worksheet.getTextBoxes().get(textboxIndex);
* //Input some text to it.
* textbox1.setText("This is another simple text box");
* //Set the placement type as the textbox will move and
* //resize with cells.
* textbox1.setPlacement(aspose.cells.PlacementType.MOVE_AND_SIZE);
* //Save the excel file.
* workbook.save("Book1.xlsx");
* @hideconstructor
*/
class TextBox {
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Get the specified math paragraph from the TextBody property of the TextBox object.
* Notice:
* (1) Returns NULL when the index is out of bounds or not found.
* (2) Also returns NULL if the specified index position is not a math paragraph.
* @param {Number} index - The position index of the math paragraph, starting from 0.
* @return {EquationNode} Returns the math paragraph specified by index.
*/
getEquationParagraph(index) {
}
/**
* Gets the first math paragraph from the TextBody property of the TextBox object.
* @return {EquationNode} If there has math paragraph, returns the first one, otherwise returns null.
*/
getEquationParagraph() {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a text box ActiveX control.
* @hideconstructor
*/
class TextBoxActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
getBorderStyle() {
}
/**
* Gets and set the type of border used by the control.
* The value of the property is ControlBorderType integer constant.
*/
setBorderStyle(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBorderOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBorderOleColor(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Gets and sets the maximum number of characters
*/
getMaxLength() {
}
/**
* Gets and sets the maximum number of characters
*/
setMaxLength(value) {
}
/**
* Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
* The value of the property is ControlScrollBarType integer constant.
*/
getScrollBars() {
}
/**
* Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
* The value of the property is ControlScrollBarType integer constant.
*/
setScrollBars(value) {
}
/**
* Gets and sets a character to be displayed in place of the characters entered.
*/
getPasswordChar() {
}
/**
* Gets and sets a character to be displayed in place of the characters entered.
*/
setPasswordChar(value) {
}
/**
* Indicates whether the user can type into the control.
*/
isEditable() {
}
/**
* Indicates whether the user can type into the control.
*/
setEditable(value) {
}
/**
* Indicates whether the control will only show complete lines of text without showing any partial lines.
*/
getIntegralHeight() {
}
/**
* Indicates whether the control will only show complete lines of text without showing any partial lines.
*/
setIntegralHeight(value) {
}
/**
* Indicates whether dragging and dropping is enabled for the control.
*/
isDragBehaviorEnabled() {
}
/**
* Indicates whether dragging and dropping is enabled for the control.
*/
setDragBehaviorEnabled(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setEnterKeyBehavior(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setEnterFieldBehavior(value) {
}
/**
* Indicates whether tab characters are allowed in the text of the control.
*/
getTabKeyBehavior() {
}
/**
* Indicates whether tab characters are allowed in the text of the control.
*/
setTabKeyBehavior(value) {
}
/**
* Indicates whether selected text in the control appears highlighted when the control does not have focus.
*/
getHideSelection() {
}
/**
* Indicates whether selected text in the control appears highlighted when the control does not have focus.
*/
setHideSelection(value) {
}
/**
* Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
*/
isAutoTab() {
}
/**
* Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters.
*/
setAutoTab(value) {
}
/**
* Indicates whether the control can display more than one line of text.
*/
isMultiLine() {
}
/**
* Indicates whether the control can display more than one line of text.
*/
setMultiLine(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAutoWordSelected(value) {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
isWordWrapped() {
}
/**
* Indicates whether the contents of the control automatically wrap at the end of a line.
*/
setWordWrapped(value) {
}
/**
* Gets and set text of the control.
*/
getText() {
}
/**
* Gets and set text of the control.
*/
setText(value) {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is DropButtonStyle integer constant.
*/
getDropButtonStyle() {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is DropButtonStyle integer constant.
*/
setDropButtonStyle(value) {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is ShowDropButtonType integer constant.
*/
getShowDropButtonTypeWhen() {
}
/**
* Specifies the symbol displayed on the drop button
* The value of the property is ShowDropButtonType integer constant.
*/
setShowDropButtonTypeWhen(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* Encapsulates a collection of TextBox objects.
* @hideconstructor
*/
class TextBoxCollection {
/**
*/
getCount() {
}
/**
* Gets the TextBox element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {TextBox} The element at the specified index.
*/
get(index) {
}
/**
* Gets the TextBox element by the name.
* @param {String} name - The name of the text box.
* @return {TextBox}
*/
get(name) {
}
/**
* Adds a textbox to the collection.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} height - Height of textbox, in unit of pixel.
* @param {Number} width - Width of textbox, in unit of pixel.
* @return {Number} TextBox object index.
*/
add(upperLeftRow, upperLeftColumn, height, width) {
}
/**
* Remove a text box from the file.
* @param {Number} index - The text box index.
*/
removeAt(index) {
}
/**
* Clear all text boxes.
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Contains properties and methods that apply to WordArt objects.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* var shapes = workbook.getWorksheets().get(0).getShapes();
* shapes.addTextEffect(aspose.cells.MsoPresetTextEffect.TEXT_EFFECT_1, "Aspose", "Arial", 30, false, false, 0, 0, 0, 0, 100, 200);
* var textEffectFormat = shapes.get(0).getTextEffect();
* textEffectFormat.setTextEffect(aspose.cells.MsoPresetTextEffect.TEXT_EFFECT_10);
* workbook.save("Book1.xls");
* @hideconstructor
*/
class TextEffectFormat {
/**
* The text in the WordArt.
*/
getText() {
}
/**
* The text in the WordArt.
*/
setText(value) {
}
/**
* The name of the font used in the WordArt.
*/
getFontName() {
}
/**
* The name of the font used in the WordArt.
*/
setFontName(value) {
}
/**
* Indicates whether font is bold.
*/
getFontBold() {
}
/**
* Indicates whether font is bold.
*/
setFontBold(value) {
}
/**
* Indicates whether font is italic.
*/
getFontItalic() {
}
/**
* Indicates whether font is italic.
*/
setFontItalic(value) {
}
/**
* If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt's bounding shape.
*/
getRotatedChars() {
}
/**
* If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt's bounding shape.
*/
setRotatedChars(value) {
}
/**
* The size (in points) of the font used in the WordArt.
*/
getFontSize() {
}
/**
* The size (in points) of the font used in the WordArt.
*/
setFontSize(value) {
}
/**
* Gets and sets the preset shape type.
* The value of the property is MsoPresetTextEffectShape integer constant.
*/
getPresetShape() {
}
/**
* Gets and sets the preset shape type.
* The value of the property is MsoPresetTextEffectShape integer constant.
*/
setPresetShape(value) {
}
/**
* Sets the preset text effect.
* @param {Number} effect - MsoPresetTextEffect
*/
setTextEffect(effect) {
}
}
/**
* Represents the text options.
* @hideconstructor
*/
class TextOptions {
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Gets and sets the user interface language.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets and sets the user interface language.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets and sets the latin name.
*/
getLatinName() {
}
/**
* Gets and sets the latin name.
*/
setLatinName(value) {
}
/**
* Gets and sets the FarEast name.
*/
getFarEastName() {
}
/**
* Gets and sets the FarEast name.
*/
setFarEastName(value) {
}
/**
* Represents the fill format of the text.
*/
getFill() {
}
/**
* Represents the outline format of the text.
*/
getOutline() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadow() {
}
/**
* Gets or sets the color of underline.
*/
getUnderlineColor() {
}
/**
* Gets or sets the color of underline.
*/
setUnderlineColor(value) {
}
/**
* Specifies the minimum font size at which character kerning will occur for this text run.
*/
getKerning() {
}
/**
* Specifies the minimum font size at which character kerning will occur for this text run.
*/
setKerning(value) {
}
/**
* Specifies the spacing between characters within a text run.
*/
getSpacing() {
}
/**
* Specifies the spacing between characters within a text run.
*/
setSpacing(value) {
}
/**
* Represent the character set.
*/
getCharset() {
}
/**
* Represent the character set.
*/
setCharset(value) {
}
/**
* Gets or sets a value indicating whether the font is italic.
*/
isItalic() {
}
/**
* Gets or sets a value indicating whether the font is italic.
*/
setItalic(value) {
}
/**
* Gets or sets a value indicating whether the font is bold.
*/
isBold() {
}
/**
* Gets or sets a value indicating whether the font is bold.
*/
setBold(value) {
}
/**
* Gets and sets the text caps type.
* The value of the property is TextCapsType integer constant.
*/
getCapsType() {
}
/**
* Gets and sets the text caps type.
* The value of the property is TextCapsType integer constant.
*/
setCapsType(value) {
}
/**
* Gets the strike type of the text.
* The value of the property is TextStrikeType integer constant.
*/
getStrikeType() {
}
/**
* Gets the strike type of the text.
* The value of the property is TextStrikeType integer constant.
*/
setStrikeType(value) {
}
/**
* Gets or sets a value indicating whether the font is single strikeout.
*/
isStrikeout() {
}
/**
* Gets or sets a value indicating whether the font is single strikeout.
*/
setStrikeout(value) {
}
/**
* Gets and sets the script offset,in unit of percentage
*/
getScriptOffset() {
}
/**
* Gets and sets the script offset,in unit of percentage
*/
setScriptOffset(value) {
}
/**
* Gets or sets a value indicating whether the font is super script.
*/
isSuperscript() {
}
/**
* Gets or sets a value indicating whether the font is super script.
*/
setSuperscript(value) {
}
/**
* Gets or sets a value indicating whether the font is subscript.
*/
isSubscript() {
}
/**
* Gets or sets a value indicating whether the font is subscript.
*/
setSubscript(value) {
}
/**
* Gets or sets the font underline type.
* The value of the property is FontUnderlineType integer constant.
*/
getUnderline() {
}
/**
* Gets or sets the font underline type.
* The value of the property is FontUnderlineType integer constant.
*/
setUnderline(value) {
}
/**
* Gets and sets the double size of the font.
*/
getDoubleSize() {
}
/**
* Gets and sets the double size of the font.
*/
setDoubleSize(value) {
}
/**
* Gets or sets the size of the font.
*/
getSize() {
}
/**
* Gets or sets the size of the font.
*/
setSize(value) {
}
/**
* Gets and sets the theme color.
* If the font color is not a theme color, NULL will be returned.
*/
getThemeColor() {
}
/**
* Gets and sets the theme color.
* If the font color is not a theme color, NULL will be returned.
*/
setThemeColor(value) {
}
/**
* Gets or sets the com.aspose.cells.Color of the font.
*/
getColor() {
}
/**
* Gets or sets the com.aspose.cells.Color of the font.
*/
setColor(value) {
}
/**
* Gets and sets the color with a 32-bit ARGB value.
*/
getArgbColor() {
}
/**
* Gets and sets the color with a 32-bit ARGB value.
*/
setArgbColor(value) {
}
/**
* Indicates whether the normalization of height that is to be applied to the text run.
*/
isNormalizeHeights() {
}
/**
* Indicates whether the normalization of height that is to be applied to the text run.
*/
setNormalizeHeights(value) {
}
/**
* Gets and sets the scheme type of the font.
* The value of the property is FontSchemeType integer constant.
*/
getSchemeType() {
}
/**
* Gets and sets the scheme type of the font.
* The value of the property is FontSchemeType integer constant.
*/
setSchemeType(value) {
}
/**
* Checks if two fonts are equals.
* @param {Font} font - Compared font object.
* @return {boolean} True if equal to the compared font object.
*/
equals(font) {
}
/**
* Returns a string represents the current Cell object.
* @return {String}
*/
toString() {
}
}
/**
* Represents the text paragraph setting.
* @hideconstructor
*/
class TextParagraph {
/**
* Gets the bullet.
*/
getBullet() {
}
/**
* Gets the type of text node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Gets and sets the amount of vertical white space that will be used within a paragraph.
* The value of the property is LineSpaceSizeType integer constant.
*/
getLineSpaceSizeType() {
}
/**
* Gets and sets the amount of vertical white space that will be used within a paragraph.
* The value of the property is LineSpaceSizeType integer constant.
*/
setLineSpaceSizeType(value) {
}
/**
* Gets and sets the amount of vertical white space that will be used within a paragraph.
*/
getLineSpace() {
}
/**
* Gets and sets the amount of vertical white space that will be used within a paragraph.
*/
setLineSpace(value) {
}
/**
* Gets and sets the amount of vertical white space that will be present after a paragraph.
* The value of the property is LineSpaceSizeType integer constant.
*/
getSpaceAfterSizeType() {
}
/**
* Gets and sets the amount of vertical white space that will be present after a paragraph.
* The value of the property is LineSpaceSizeType integer constant.
*/
setSpaceAfterSizeType(value) {
}
/**
* Gets and sets the amount of vertical white space that will be present after a paragraph.
*/
getSpaceAfter() {
}
/**
* Gets and sets the amount of vertical white space that will be present after a paragraph.
*/
setSpaceAfter(value) {
}
/**
* Gets and sets the amount of vertical white space that will be present before a paragraph.
* The value of the property is LineSpaceSizeType integer constant.
*/
getSpaceBeforeSizeType() {
}
/**
* Gets and sets the amount of vertical white space that will be present before a paragraph.
* The value of the property is LineSpaceSizeType integer constant.
*/
setSpaceBeforeSizeType(value) {
}
/**
* Gets and sets the amount of vertical white space that will be present before a paragraph.
*/
getSpaceBefore() {
}
/**
* Gets and sets the amount of vertical white space that will be present before a paragraph.
*/
setSpaceBefore(value) {
}
/**
* Gets tab stop list.
*/
getStops() {
}
/**
* Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
*/
isLatinLineBreak() {
}
/**
* Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
*/
setLatinLineBreak(value) {
}
/**
* Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
*/
isEastAsianLineBreak() {
}
/**
* Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
*/
setEastAsianLineBreak(value) {
}
/**
* Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
*/
isHangingPunctuation() {
}
/**
* Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
*/
setHangingPunctuation(value) {
}
/**
* Specifies the right margin of the paragraph.
*/
getRightMargin() {
}
/**
* Specifies the right margin of the paragraph.
*/
setRightMargin(value) {
}
/**
* Specifies the left margin of the paragraph.
*/
getLeftMargin() {
}
/**
* Specifies the left margin of the paragraph.
*/
setLeftMargin(value) {
}
/**
* Specifies the indent size that will be applied to the first line of text in the paragraph.
*/
getFirstLineIndent() {
}
/**
* Specifies the indent size that will be applied to the first line of text in the paragraph.
*/
setFirstLineIndent(value) {
}
/**
* 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.
* The value of the property is TextFontAlignType integer constant.
*/
getFontAlignType() {
}
/**
* 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.
* The value of the property is TextFontAlignType integer constant.
*/
setFontAlignType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the paragraph.
* The value of the property is TextAlignmentType integer constant.
*/
getAlignmentType() {
}
/**
* Gets and sets the text horizontal alignment type of the paragraph.
* The value of the property is TextAlignmentType integer constant.
*/
setAlignmentType(value) {
}
/**
* Gets and sets the default size for a tab character within this paragraph.
*/
getDefaultTabSize() {
}
/**
* Gets and sets the default size for a tab character within this paragraph.
*/
setDefaultTabSize(value) {
}
/**
* Gets all text runs in this paragraph.
* If this paragraph is empty, return paragraph itself.
*/
getChildren() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents all text paragraph.
* @hideconstructor
*/
class TextParagraphCollection {
/**
* Gets the count of text paragraphs.
*/
getCount() {
}
/**
* Gets the TextParagraph object at specific index.
* @param {Number} index - The index.
* @return {TextParagraph}
*/
get(index) {
}
/**
* Gets the enumerator of the paragraphs.
* @return {Iterator}
*/
iterator() {
}
}
/**
* 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.
* @hideconstructor
*/
class TextRunEquationNode {
/**
* Set the content of the text node(Usually a node object per character).
*/
getText() {
}
/**
* Set the content of the text node(Usually a node object per character).
*/
setText(value) {
}
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Represents tab stop.
* @hideconstructor
*/
class TextTabStop {
/**
* Specifies the alignment that is to be applied to text using this tab stop.
* The value of the property is TextTabAlignmentType integer constant.
*/
getTabAlignment() {
}
/**
* Specifies the alignment that is to be applied to text using this tab stop.
* The value of the property is TextTabAlignmentType integer constant.
*/
setTabAlignment(value) {
}
/**
* Specifies the position of the tab stop relative to the left margin.
*/
getTabPosition() {
}
/**
* Specifies the position of the tab stop relative to the left margin.
*/
setTabPosition(value) {
}
}
/**
* Represents the list of all tab stops.
*/
class TextTabStopCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets TextTabStop by the index.
* @param {Number} index - The index.
* @return {TextTabStop}
*/
get(index) {
}
/**
* Adds a tab stop.
* @param {Number} tabAlignment - TextTabAlignmentType
* @param {Number} tabPosition
* @return {Number}
*/
add(tabAlignment, tabPosition) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Encapsulates the object that represents texture fill format
* @hideconstructor
*/
class TextureFill {
/**
* Gets and sets the texture type
* The value of the property is TextureType integer constant.
*/
getType() {
}
/**
* Gets and sets the texture type
* The value of the property is TextureType integer constant.
*/
setType(value) {
}
/**
* Gets and sets the image data of the fill.
*/
getImageData() {
}
/**
* Gets and sets the image data of the fill.
*/
setImageData(value) {
}
/**
* Indicates whether tile picture as texture.
*/
isTiling() {
}
/**
* Indicates whether tile picture as texture.
*/
setTiling(value) {
}
/**
* Gets or sets picture format option.
*/
getPicFormatOption() {
}
/**
* Gets or sets picture format option.
*/
setPicFormatOption(value) {
}
/**
* Gets or sets tile picture option.
*/
getTilePicOption() {
}
/**
* Gets or sets tile picture option.
*/
setTilePicOption(value) {
}
/**
* Gets and sets the picture format type.
* The value of the property is FillPictureType integer constant.
*/
getPictureFormatType() {
}
/**
* Gets and sets the picture format type.
* The value of the property is FillPictureType integer constant.
*/
setPictureFormatType(value) {
}
/**
* Gets and sets the picture format scale.
*/
getScale() {
}
/**
* Gets and sets the picture format scale.
*/
setScale(value) {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* /
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
/**
* Gets the hash code.
* @return {Number}
*/
hashCode() {
}
}
/**
* Represents a theme color.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* var cells = workbook.getWorksheets().get(0).getCells();
* cells.get("A1").putValue("Hello World");
* var style = cells.get("A1").getStyle();
* //Set ThemeColorType.Text2 color type with 40% lighten as the font color.
* style.getFont().setThemeColor(new aspose.cells.ThemeColor(aspose.cells.ThemeColorType.TEXT_2, 0.4));
* style.setPattern(aspose.cells.BackgroundType.SOLID);
* //Set ThemeColorType.Background2 color type with 75% darken as the foreground color
* style.setForegroundThemeColor(new aspose.cells.ThemeColor(aspose.cells.ThemeColorType.BACKGROUND_2, -0.75));
* cells.get("A1").setStyle(style);
* //Saving the Excel file
* workbook.save("Book1.xlsx");
*/
class ThemeColor {
/**
* @param {Number} type - ThemeColorType
* @param {Number} tint - The tint value.
*/
constructor(type, tint) {
}
/**
* Gets and sets the theme type.
* The value of the property is ThemeColorType integer constant.
*/
getColorType() {
}
/**
* Gets and sets the theme type.
* The value of the property is ThemeColorType integer constant.
*/
setColorType(value) {
}
/**
* Gets and sets the tint value.
* The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken
* and 1.0 means 100% lighten. Also, 0.0 means no change.
*/
getTint() {
}
/**
* Gets and sets the tint value.
* The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken
* and 1.0 means 100% lighten. Also, 0.0 means no change.
*/
setTint(value) {
}
}
/**
* Represents the threaded comment.
* @hideconstructor
*/
class ThreadedComment {
/**
* Gets the row index of the comment.
*/
getRow() {
}
/**
* Gets the column index of the comment.
*/
getColumn() {
}
/**
* Gets and sets the text of the comment.
*/
getNotes() {
}
/**
* Gets and sets the text of the comment.
*/
setNotes(value) {
}
/**
* Gets the author of the comment.
*/
getAuthor() {
}
/**
* Gets the author of the comment.
*/
setAuthor(value) {
}
/**
* Gets and sets the created time of this threaded comment.
*/
getCreatedTime() {
}
/**
* Gets and sets the created time of this threaded comment.
*/
setCreatedTime(value) {
}
}
/**
* Represents the person who creates the threaded comments;
* @hideconstructor
*/
class ThreadedCommentAuthor {
/**
* Gets and sets the name.
*/
getName() {
}
/**
* Gets and sets the name.
*/
setName(value) {
}
/**
* Gets and sets the id of the user.
*/
getUserId() {
}
/**
* Gets and sets the id of the user.
*/
setUserId(value) {
}
/**
* Gets the id of the provider.
*/
getProviderId() {
}
/**
* Gets the id of the provider.
*/
setProviderId(value) {
}
}
/**
* Represents all persons who .
*/
class ThreadedCommentAuthorCollection {
/**
*/
constructor() {
}
/**
* Gets and sets the current user.
*/
getCurrentPerson() {
}
/**
* Gets and sets the current user.
*/
setCurrentPerson(value) {
}
/**
*/
getCount() {
}
/**
* Gets the person who create threaded comments.
* @param {Number} index - The index
* @return {ThreadedCommentAuthor}
*/
get(index) {
}
/**
* Gets the person who create threaded comments.
* @param {String} name - The name of the author.
* @return {ThreadedCommentAuthor}
*/
get(name) {
}
/**
* Gets the index of ThreadedCommentAuthor object
* @param {ThreadedCommentAuthor} author - The ThreadedCommentAuthor object
* @return {Number} The index in the ThreadedCommentAuthor collection
*/
indexOf(author) {
}
/**
* Adds one thread comment person.
* @param {String} name - The name of the person.
* @param {String} userId
* @param {String} providerId - The id of the provider
* @return {Number}
*/
add(name, userId, providerId) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the list of threaded comments.
* @hideconstructor
*/
class ThreadedCommentCollection {
/**
*/
getCount() {
}
/**
* Gets the threaded comment by the specific index.
* @param {Number} index - The index
* @return {ThreadedComment}
*/
get(index) {
}
/**
* Adds a threaded comment;
* @param {String} text - The text of the threaded comment.
* @param {ThreadedCommentAuthor} author - The author of the threaded comment
* @return {Number}
*/
add(text, author) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Simple implementation of AbstractInterruptMonitor by starting another thread to require the interruption after sleeping user specified limit.
* One monitor instance can be used repeatedly, as long as you monitor each process in sequence.
* It should not be used to monitor multiple procedures concurrently in multi-threads.
*/
class ThreadInterruptMonitor {
/**
* Constructs one interruption monitor.
* @param {boolean} terminateWithoutException - TerminateWithoutException
*/
constructor(terminateWithoutException) {
}
/**
* This implementation just checks whether the time cost(from the time when starting this monitor to now) is greater than user specified limit.
*/
isInterruptionRequested() {
}
/**
* See TerminateWithoutException.
* This property is specified by user when constructing this monitor instance.
*/
getTerminateWithoutException() {
}
/**
* 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 {Number} msLimit - time limit(ms) to require the interruption.
*/
startMonitor(msLimit) {
}
/**
* Finishes the monitor for one procedure.
* Calling this method after the monitored procedure can release the monitor thread earlier,
* especially when there is no interruption for it(the time cost of that procedure is less than the specified time limit).
*/
finishMonitor() {
}
}
/**
* Represents a shape's three-dimensional formatting.
* @hideconstructor
*/
class ThreeDFormat {
/**
* Gets and sets the width of the bottom bevel, or how far into the shape it is applied.
* In unit of Points.
*/
getBottomBevelWidth() {
}
/**
* Gets and sets the width of the bottom bevel, or how far into the shape it is applied.
* In unit of Points.
*/
setBottomBevelWidth(value) {
}
/**
* Gets and sets the height of the bottom bevel, or how far into the shape it is applied.
* In unit of Points.
*/
getBottomBevelHeight() {
}
/**
* Gets and sets the height of the bottom bevel, or how far into the shape it is applied.
* In unit of Points.
*/
setBottomBevelHeight(value) {
}
/**
* Gets and sets the type of the bottom bevel, or how far into the shape it is applied.
* In unit of Points.
* The value of the property is BevelType integer constant.
*/
getBottomBevelType() {
}
/**
* Gets and sets the type of the bottom bevel, or how far into the shape it is applied.
* In unit of Points.
* The value of the property is BevelType integer constant.
*/
setBottomBevelType(value) {
}
/**
* Gets and sets the width of the top bevel, or how far into the shape it is applied.
* In unit of Points.
*/
getTopBevelWidth() {
}
/**
* Gets and sets the width of the top bevel, or how far into the shape it is applied.
* In unit of Points.
*/
setTopBevelWidth(value) {
}
/**
* Gets and sets the height of the top bevel, or how far into the shape it is applied.
* In unit of Points.
*/
getTopBevelHeight() {
}
/**
* Gets and sets the height of the top bevel, or how far into the shape it is applied.
* In unit of Points.
*/
setTopBevelHeight(value) {
}
/**
* Gets and sets the type of the top bevel, or how far into the shape it is applied.
* In unit of Points.
* The value of the property is BevelType integer constant.
*/
getTopBevelType() {
}
/**
* Gets and sets the type of the top bevel, or how far into the shape it is applied.
* In unit of Points.
* The value of the property is BevelType integer constant.
*/
setTopBevelType(value) {
}
/**
* Represents the preset material which is combined with the lighting properties to give the
* final look and feel of a shape.
* The value of the property is PresetMaterialType integer constant.
*/
getMaterial() {
}
/**
* Represents the preset material which is combined with the lighting properties to give the
* final look and feel of a shape.
* The value of the property is PresetMaterialType integer constant.
*/
setMaterial(value) {
}
/**
* Gets and sets the contour color on a shape.
*/
getContourColor() {
}
/**
* Gets and sets the contour color on a shape.
*/
setContourColor(value) {
}
/**
* Gets and sets the contour width on the shape, in unit of points.
*/
getContourWidth() {
}
/**
* Gets and sets the contour width on the shape, in unit of points.
*/
setContourWidth(value) {
}
/**
* Gets the extrusion color on a shape.
*/
getExtrusionColor() {
}
/**
* Gets the extrusion color on a shape.
*/
setExtrusionColor(value) {
}
/**
* Gets and sets the extrusion height of the applied to the shape, in unit of points.
*/
getExtrusionHeight() {
}
/**
* Gets and sets the extrusion height of the applied to the shape, in unit of points.
*/
setExtrusionHeight(value) {
}
/**
* Defines the distance from ground for the 3D shape.
*/
getZ() {
}
/**
* Defines the distance from ground for the 3D shape.
*/
setZ(value) {
}
/**
* Gets and sets the angle of the extrusion lights.
*/
getLightAngle() {
}
/**
* Gets and sets the angle of the extrusion lights.
*/
setLightAngle(value) {
}
/**
* Gets and sets type of light rig.
* The value of the property is LightRigType integer constant.
*/
getLighting() {
}
/**
* Gets and sets type of light rig.
* The value of the property is LightRigType integer constant.
*/
setLighting(value) {
}
/**
* Gets and sets the direction from which the light rig is oriented in relation to the scene.
* The value of the property is LightRigDirectionType integer constant.
*/
getLightingDirection() {
}
/**
* Gets and sets the direction from which the light rig is oriented in relation to the scene.
* The value of the property is LightRigDirectionType integer constant.
*/
setLightingDirection(value) {
}
/**
* Gets and sets the angle at which a ThreeDFormat object can be viewed.
*/
getPerspective() {
}
/**
* Gets and sets the angle at which a ThreeDFormat object can be viewed.
*/
setPerspective(value) {
}
/**
* Gets and sets the rotation of the extruded shape around the x-axis in degrees.
*/
getRotationX() {
}
/**
* Gets and sets the rotation of the extruded shape around the x-axis in degrees.
*/
setRotationX(value) {
}
/**
* Gets and sets the rotation of the extruded shape around the y-axis in degrees.
*/
getRotationY() {
}
/**
* Gets and sets the rotation of the extruded shape around the y-axis in degrees.
*/
setRotationY(value) {
}
/**
* Gets and sets the rotation of the extruded shape around the z-axis in degrees.
*/
getRotationZ() {
}
/**
* Gets and sets the rotation of the extruded shape around the z-axis in degrees.
*/
setRotationZ(value) {
}
/**
* Gets and sets the extrusion preset camera type.
* The value of the property is PresetCameraType integer constant.
*/
getPresetCameraType() {
}
/**
* Gets and sets the extrusion preset camera type.
* The value of the property is PresetCameraType integer constant.
*/
setPresetCameraType(value) {
}
/**
* Gets hashcode.
* @return {Number}
*/
hashCode() {
}
/**
* @param {Object} obj
* @return {boolean}
*/
equals(obj) {
}
}
/**
* Represents a tick label in the chart.
* @hideconstructor
*/
class TickLabelItem {
/**
* X coordinates of Ticklabel item in ratio of chart width.
*/
getX() {
}
/**
* Y coordinates of Ticklabel item in ratio of chart height.
*/
getY() {
}
/**
* Width of Ticklabel item in ratio of chart width.
*/
getWidth() {
}
/**
* Height of Ticklabel item in ratio of chart height.
*/
getHeight() {
}
}
/**
* Represents the tick-mark labels associated with tick marks on a chart axis.
* @hideconstructor
*/
class TickLabels {
/**
* Returns a Font object that represents the font of the specified TickLabels object.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Represents text rotation angle in clockwise.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
getRotationAngle() {
}
/**
* Represents text rotation angle in clockwise.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
setRotationAngle(value) {
}
/**
* Indicates whether the rotation angle is automatic
*/
isAutomaticRotation() {
}
/**
* Indicates whether the rotation angle is automatic
*/
setAutomaticRotation(value) {
}
/**
* Represents the format string for the TickLabels object.
* The formatting string is same as a custom format string setting to a cell. For example, "$0".
*/
getNumberFormat() {
}
/**
* Represents the format string for the TickLabels object.
* The formatting string is same as a custom format string setting to a cell. For example, "$0".
*/
setNumberFormat(value) {
}
/**
* Represents the format number for the TickLabels object.
*/
getNumber() {
}
/**
* Represents the format number for the TickLabels object.
*/
setNumber(value) {
}
/**
* True if the number format is linked to the cells
* (so that the number format changes in the labels when it changes in the cells).
*/
getNumberFormatLinked() {
}
/**
* True if the number format is linked to the cells
* (so that the number format changes in the labels when it changes in the cells).
*/
setNumberFormatLinked(value) {
}
/**
* Gets and sets the display number format of tick labels.
*/
getDisplayNumberFormat() {
}
/**
* Gets and sets the distance of labels from the axis.
* The default distance is 100 percent, which represents the default spacing between the axis labels and the axis line.
* The value can be an integer percentage from 0 through 1000, relative to the axis label’s font size.
*/
getOffset() {
}
/**
* Gets and sets the distance of labels from the axis.
* The default distance is 100 percent, which represents the default spacing between the axis labels and the axis line.
* The value can be an integer percentage from 0 through 1000, relative to the axis label’s font size.
*/
setOffset(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use TickLabels.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextDirection() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use TickLabels.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTextDirection(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
getReadingOrder() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
setReadingOrder(value) {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
getDirectionType() {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
setDirectionType(value) {
}
/**
* Gets each tick label item's information of axis.
* Only available after calling Chart.calculate() method.
*/
getTickLabelItems() {
}
/**
* Gets and sets the text alignment for the tick labels on the axis.
* The value of the property is TickLabelAlignmentType integer constant.
*/
getAlignmentType() {
}
/**
* Gets and sets the text alignment for the tick labels on the axis.
* The value of the property is TickLabelAlignmentType integer constant.
*/
setAlignmentType(value) {
}
}
/**
* Represents tile picture as texture.
*/
class TilePicOption {
/**
*/
constructor() {
}
/**
* Gets or sets the X offset for tiling picture.
*/
getOffsetX() {
}
/**
* Gets or sets the X offset for tiling picture.
*/
setOffsetX(value) {
}
/**
* Gets or sets the Y offset for tiling picture.
*/
getOffsetY() {
}
/**
* Gets or sets the Y offset for tiling picture.
*/
setOffsetY(value) {
}
/**
* Gets or sets the X scale for tiling picture.
*/
getScaleX() {
}
/**
* Gets or sets the X scale for tiling picture.
*/
setScaleX(value) {
}
/**
* Gets or sets the Y scale for tiling picture.
*/
getScaleY() {
}
/**
* Gets or sets the Y scale for tiling picture.
*/
setScaleY(value) {
}
/**
* Gets or sets the mirror type for tiling.
* The value of the property is MirrorType integer constant.
*/
getMirrorType() {
}
/**
* Gets or sets the mirror type for tiling.
* The value of the property is MirrorType integer constant.
*/
setMirrorType(value) {
}
/**
* Gets or sets the alignment for tiling.
* The value of the property is RectangleAlignmentType integer constant.
*/
getAlignmentType() {
}
/**
* Gets or sets the alignment for tiling.
* The value of the property is RectangleAlignmentType integer constant.
*/
setAlignmentType(value) {
}
}
/**
* Summary description of Timeline View
* Due to MS Excel, Excel 2003 does not support Timeline
* @hideconstructor
*/
class Timeline {
/**
* Returns or sets the caption of the specified Timeline.
*/
getCaption() {
}
/**
* Returns or sets the caption of the specified Timeline.
*/
setCaption(value) {
}
/**
* Returns or sets the name of the specified Timeline
*/
getName() {
}
/**
* Returns or sets the name of the specified Timeline
*/
setName(value) {
}
/**
* Returns or sets the horizontal offset of timeline shape from its left column, in pixels.
*/
getLeftPixel() {
}
/**
* Returns or sets the horizontal offset of timeline shape from its left column, in pixels.
*/
setLeftPixel(value) {
}
/**
* Returns or sets the vertical offset of timeline shape from its top row, in pixels.
*/
getTopPixel() {
}
/**
* Returns or sets the vertical offset of timeline shape from its top row, in pixels.
*/
setTopPixel(value) {
}
/**
* Returns or sets the width of the specified timeline, in pixels.
*/
getWidthPixel() {
}
/**
* Returns or sets the width of the specified timeline, in pixels.
*/
setWidthPixel(value) {
}
/**
* Returns or sets the height of the specified timeline, in pixels.
*/
getHeightPixel() {
}
/**
* Returns or sets the height of the specified timeline, in pixels.
*/
setHeightPixel(value) {
}
}
/**
* Specifies the collection of all the Timeline objects on the specified worksheet.
* Due to MS Excel, Excel 2003 does not support Timeline.
* @hideconstructor
*/
class TimelineCollection {
/**
*/
getCount() {
}
/**
* Gets the Timeline by index.
*/
get(index) {
}
/**
* Gets the Timeline by Timeline's name.
*/
get(name) {
}
/**
* Add a new Timeline using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {Number} row - Row index of the cell in the upper-left corner of the Timeline range.
* @param {Number} column - Column index of the cell in the upper-left corner of the Timeline range.
* @param {String} baseFieldName - The name of PivotField in PivotTable.BaseFields
* @return {Number} The new add Timeline index
*/
add(pivot, row, column, baseFieldName) {
}
/**
* Add a new Timeline using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {String} destCellName - The cell name in the upper-left corner of the Timeline range.
* @param {String} baseFieldName - The name of PivotField in PivotTable.BaseFields
* @return {Number} The new add Timeline index
*/
add(pivot, destCellName, baseFieldName) {
}
/**
* Add a new Timeline using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {Number} row - Row index of the cell in the upper-left corner of the Timeline range.
* @param {Number} column - Column index of the cell in the upper-left corner of the Timeline range.
* @param {Number} baseFieldIndex - The index of PivotField in PivotTable.BaseFields
* @return {Number} The new add Timeline index
*/
add(pivot, row, column, baseFieldIndex) {
}
/**
* Add a new Timeline using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {String} destCellName - The cell name in the upper-left corner of the Timeline range.
* @param {Number} baseFieldIndex - The index of PivotField in PivotTable.BaseFields
* @return {Number} The new add Timeline index
*/
add(pivot, destCellName, baseFieldIndex) {
}
/**
* Add a new Timeline using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {Number} row - Row index of the cell in the upper-left corner of the Timeline range.
* @param {Number} column - Column index of the cell in the upper-left corner of the Timeline range.
* @param {PivotField} baseField - The PivotField in PivotTable.BaseFields
* @return {Number} The new add Timeline index
*/
add(pivot, row, column, baseField) {
}
/**
* Add a new Timeline using PivotTable as data source
* @param {PivotTable} pivot - PivotTable object
* @param {String} destCellName - The cell name in the upper-left corner of the Timeline range.
* @param {PivotField} baseField - The PivotField in PivotTable.BaseFields
* @return {Number} The new add Timeline index
*/
add(pivot, destCellName, baseField) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Encapsulates the object that represents the title of chart or axis.
* @example
* var excel = new aspose.cells.Workbook();
* var charts = excel.getWorksheets().get(0).getCharts();
* //Create a chart
* var chart = charts.get(charts.add(aspose.cells.ChartType.COLUMN, 1, 1, 10, 10));
* //Setting the title of a chart
* chart.getTitle().setText("Title");
* //Setting the font color of the chart title to blue
* chart.getTitle().getTextFont().setColor(aspose.cells.Color.getBlue());
* //Setting the title of category axis of the chart
* chart.getCategoryAxis().getTitle().setText("Category");
* //Setting the title of value axis of the chart
* chart.getValueAxis().getTitle().setText("Value");
* @hideconstructor
*/
class Title {
/**
* Gets or sets the text of display unit label.
*/
getText() {
}
/**
* Gets or sets the text of display unit label.
*/
setText(value) {
}
/**
* Represents whether the title is visible.
*/
isVisible() {
}
/**
* Represents whether the title is visible.
*/
setVisible(value) {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
*/
getX() {
}
/**
* Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
*/
setX(value) {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
*/
getY() {
}
/**
* Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
*/
setY(value) {
}
/**
* Represents overlay centered title on chart without resizing chart.
*/
getOverLay() {
}
/**
* Represents overlay centered title on chart without resizing chart.
*/
setOverLay(value) {
}
/**
* Indicates the text is auto generated.
*/
isAutoText() {
}
/**
* Indicates the text is auto generated.
*/
setAutoText(value) {
}
/**
* Indicates whether this data labels is deleted.
*/
isDeleted() {
}
/**
* Indicates whether this data labels is deleted.
*/
setDeleted(value) {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets or sets the text vertical alignment of text.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
getRotationAngle() {
}
/**
* Represents text rotation angle.
* 0: Not rotated.255: Top to Bottom.-90: Downward.90: Upward.
*/
setRotationAngle(value) {
}
/**
* Indicates whether the text of the chart is automatically rotated.
*/
isAutomaticRotation() {
}
/**
* Gets and sets a reference to the worksheet.
*/
getLinkedSource() {
}
/**
* Gets and sets a reference to the worksheet.
*/
setLinkedSource(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextDirection() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartTextFrame.ReadingOrder property.
* This property will be removed 12 months later since March 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTextDirection(value) {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
getReadingOrder() {
}
/**
* Represents text reading order.
* The value of the property is TextDirectionType integer constant.
*/
setReadingOrder(value) {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
getDirectionType() {
}
/**
* Gets and sets the direction of text.
* The value of the property is ChartTextDirectionType integer constant.
*/
setDirectionType(value) {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
isTextWrapped() {
}
/**
* Gets or sets a value indicating whether the text is wrapped.
*/
setTextWrapped(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setResizeShapeToFitText(value) {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
isInnerMode() {
}
/**
* Indicates whether the size of the plot area size includes the tick marks, and the axis labels.
* False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
* Only for Xlsx file.
*/
setInnerMode(value) {
}
/**
* Gets the chart to which this object belongs.
*/
getChart() {
}
/**
* Gets the Line.
*/
getBorder() {
}
/**
* Gets the area.
*/
getArea() {
}
/**
* Gets a Font object of the specified ChartFrame object.
* NOTE: This member is now obsolete. Instead,
* please use ChartFrame.Font property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFont() {
}
/**
* Gets and sets the options of the text.
*/
getTextOptions() {
}
/**
* Gets a Font object of the specified ChartFrame object.
*/
getFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
getAutoScaleFont() {
}
/**
* True if the text in the object changes font size when the object size changes. The default value is True.
*/
setAutoScaleFont(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
getBackgroundMode() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.
*/
setBackgroundMode(value) {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getBackground() {
}
/**
* Gets and sets the display mode of the background
* The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead,
* please use ChartFrame.BackgroundMode property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setBackground(value) {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
isAutomaticSize() {
}
/**
* Indicates whether the chart frame is automatic sized.
*/
setAutomaticSize(value) {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
getHeight() {
}
/**
* Gets or sets the height of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Height In Pixels = Y * Chart.ChartObject.Height / 4000;
*/
setHeight(value) {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
getWidth() {
}
/**
* Gets or sets the width of frame in units of 1/4000 of the chart area.
* How to convert units of 1/4000 to pixels?
* Width In Pixels = Width * Chart.ChartObject.Height / 4000;
*/
setWidth(value) {
}
/**
* True if the frame has a shadow.
*/
getShadow() {
}
/**
* True if the frame has a shadow.
*/
setShadow(value) {
}
/**
* Gets the ShapeProperties object.
*/
getShapeProperties() {
}
/**
* Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
*/
isDefaultPosBeSet() {
}
/**
* Represents x of default position
*/
getDefaultX() {
}
/**
* Represents y of default position
*/
getDefaultY() {
}
/**
* Represents width of default position
*/
getDefaultWidth() {
}
/**
* Represents height of default position
*/
getDefaultHeight() {
}
/**
* Gets rich text formatting of this Title.
* NOTE: This member is now obsolete.
* Instead, please use Title.Characters() method.
* This property will be removed 12 months later since November 2016.
* Aspose apologizes for any inconvenience you may have experienced.@return {FontSetting[]} returns FontSetting array
*/
getCharacters() {
}
/**
* Gets rich text formatting of this Title.
* @return {FontSetting[]} returns FontSetting array
*/
characters() {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Set position of the frame to automatic
*/
setPositionAuto() {
}
}
/**
* Represents a ToggleButton ActiveX control.
* @hideconstructor
*/
class ToggleButtonActiveXControl {
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
getCaption() {
}
/**
* Gets and set the descriptive text that appears on a control.
*/
setCaption(value) {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
getPicturePosition() {
}
/**
* Gets and set the location of the control's picture relative to its caption.
* The value of the property is ControlPicturePositionType integer constant.
*/
setPicturePosition(value) {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
getSpecialEffect() {
}
/**
* Gets and sets the special effect of the control.
* The value of the property is ControlSpecialEffectType integer constant.
*/
setSpecialEffect(value) {
}
/**
* Gets and sets the data of the picture.
*/
getPicture() {
}
/**
* Gets and sets the data of the picture.
*/
setPicture(value) {
}
/**
* Gets and sets the accelerator key for the control.
*/
getAccelerator() {
}
/**
* Gets and sets the accelerator key for the control.
*/
setAccelerator(value) {
}
/**
* Indicates if the control is checked or not.
* The value of the property is CheckValueType integer constant.
*/
getValue() {
}
/**
* Indicates if the control is checked or not.
* The value of the property is CheckValueType integer constant.
*/
setValue(value) {
}
/**
* Indicates how the specified control will display Null values.
* SettingDescriptionTrueThe 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() {
}
/**
* Indicates how the specified control will display Null values.
* SettingDescriptionTrueThe 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.
*/
setTripleState(value) {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
}
/**
* 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.
*/
class Top10 {
/**
*/
constructor() {
}
/**
* Get or set whether a "top/bottom n" rule is a "top/bottom n percent" rule.
* Default value is false.
*/
isPercent() {
}
/**
* Get or set whether a "top/bottom n" rule is a "top/bottom n percent" rule.
* Default value is false.
*/
setPercent(value) {
}
/**
* Get or set whether a "top/bottom n" rule is a "bottom n" rule.
* Default value is false.
*/
isBottom() {
}
/**
* Get or set whether a "top/bottom n" rule is a "bottom n" rule.
* Default value is false.
*/
setBottom(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setRank(value) {
}
}
/**
* Represents the top 10 filter.
* @hideconstructor
*/
class Top10Filter {
/**
* Indicates whether it's top filter.
*/
isTop() {
}
/**
* Indicates whether it's top filter.
*/
setTop(value) {
}
/**
* Indicates whether the items is percent.
*/
isPercent() {
}
/**
* Indicates whether the items is percent.
*/
setPercent(value) {
}
/**
* Gets and sets the items of the filter.
*/
getItems() {
}
/**
* Gets and sets the items of the filter.
*/
setItems(value) {
}
/**
*/
getCriteria() {
}
/**
*/
setCriteria(value) {
}
}
/**
* Represents a trendline in a chart.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Excel object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a sample value to "A4" cell
* worksheet.getCells().get("A4").putValue(200);
* //Adding a sample value to "B1" cell
* worksheet.getCells().get("B1").putValue(60);
* //Adding a sample value to "B2" cell
* worksheet.getCells().get("B2").putValue(32);
* //Adding a sample value to "B3" cell
* worksheet.getCells().get("B3").putValue(50);
* //Adding a sample value to "B4" cell
* worksheet.getCells().get("B4").putValue(40);
* //Adding a sample value to "C1" cell as category data
* worksheet.getCells().get("C1").putValue("Q1");
* //Adding a sample value to "C2" cell as category data
* worksheet.getCells().get("C2").putValue("Q2");
* //Adding a sample value to "C3" cell as category data
* worksheet.getCells().get("C3").putValue("Y1");
* //Adding a sample value to "C4" cell as category data
* worksheet.getCells().get("C4").putValue("Y2");
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
* chart.getNSeries().add("A1:B4", true);
* //Setting the data source for the category data of NSeries
* chart.getNSeries().setCategoryData("C1:C4");
* //adding a linear trendline
* var index = chart.getNSeries().get(0).getTrendLines().add(aspose.cells.TrendlineType.LINEAR);
* var trendline = chart.getNSeries().get(0).getTrendLines().get(index);
* //Setting the custom name of the trendline.
* trendline.setName("Linear");
* //Displaying the equation on chart
* trendline.setDisplayEquation(true);
* //Displaying the R-Squared value on chart
* trendline.setDisplayRSquared(true);
* //Saving the Excel file
* workbook.save("Book1.xls");
* @hideconstructor
*/
class Trendline {
/**
* Returns if Microsoft Excel automatically determines the name of the trendline.
*/
isNameAuto() {
}
/**
* Returns if Microsoft Excel automatically determines the name of the trendline.
*/
setNameAuto(value) {
}
/**
* Returns the trendline type.
* The value of the property is TrendlineType integer constant.
*/
getType() {
}
/**
* Returns the name of the trendline.
*/
getName() {
}
/**
* Returns the name of the trendline.
*/
setName(value) {
}
/**
* Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial.
* The order must be between 2 and 6.
*/
getOrder() {
}
/**
* Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial.
* The order must be between 2 and 6.
*/
setOrder(value) {
}
/**
* Returns or sets the period for the moving-average trendline.
* This value should be between 2 and 255.
* And it must be less than the number of the chart points in the series
*/
getPeriod() {
}
/**
* Returns or sets the period for the moving-average trendline.
* This value should be between 2 and 255.
* And it must be less than the number of the chart points in the series
*/
setPeriod(value) {
}
/**
* Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward.
* The number of periods must be greater than or equal to zero.
*/
getForward() {
}
/**
* Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward.
* The number of periods must be greater than or equal to zero.
*/
setForward(value) {
}
/**
* Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward.
* The number of periods must be greater than or equal to zero.
* If the chart type is column ,the number of periods must be between 0 and 0.5
*/
getBackward() {
}
/**
* Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward.
* The number of periods must be greater than or equal to zero.
* If the chart type is column ,the number of periods must be between 0 and 0.5
*/
setBackward(value) {
}
/**
* Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.
*/
getDisplayEquation() {
}
/**
* Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.
*/
setDisplayEquation(value) {
}
/**
* Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.
*/
getDisplayRSquared() {
}
/**
* Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.
*/
setDisplayRSquared(value) {
}
/**
* Returns or sets the point where the trendline crosses the value axis.
*/
getIntercept() {
}
/**
* Returns or sets the point where the trendline crosses the value axis.
*/
setIntercept(value) {
}
/**
* Represents the DataLabels object for the specified series.
*/
getDataLabels() {
}
/**
* Gets the legend entry according to this trendline
*/
getLegendEntry() {
}
/**
* Specifies the compound line type
* The value of the property is MsoLineStyle integer constant.
*/
getCompoundType() {
}
/**
* Specifies the compound line type
* The value of the property is MsoLineStyle integer constant.
*/
setCompoundType(value) {
}
/**
* Specifies the dash line type
* The value of the property is MsoLineDashStyle integer constant.
*/
getDashType() {
}
/**
* Specifies the dash line type
* The value of the property is MsoLineDashStyle integer constant.
*/
setDashType(value) {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
getCapType() {
}
/**
* Specifies the ending caps.
* The value of the property is LineCapType integer constant.
*/
setCapType(value) {
}
/**
* Specifies the joining caps.
* The value of the property is LineJoinType integer constant.
*/
getJoinType() {
}
/**
* Specifies the joining caps.
* The value of the property is LineJoinType integer constant.
*/
setJoinType(value) {
}
/**
* Specifies an arrowhead for the begin of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getBeginType() {
}
/**
* Specifies an arrowhead for the begin of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setBeginType(value) {
}
/**
* Specifies an arrowhead for the end of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
getEndType() {
}
/**
* Specifies an arrowhead for the end of a line.
* The value of the property is MsoArrowheadStyle integer constant.
*/
setEndType(value) {
}
/**
* Specifies the length of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getBeginArrowLength() {
}
/**
* Specifies the length of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setBeginArrowLength(value) {
}
/**
* Specifies the length of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
getEndArrowLength() {
}
/**
* Specifies the length of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadLength integer constant.
*/
setEndArrowLength(value) {
}
/**
* Specifies the width of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getBeginArrowWidth() {
}
/**
* Specifies the width of the arrowhead for the begin of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setBeginArrowWidth(value) {
}
/**
* Specifies the width of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
getEndArrowWidth() {
}
/**
* Specifies the width of the arrowhead for the end of a line.
* The value of the property is MsoArrowheadWidth integer constant.
*/
setEndArrowWidth(value) {
}
/**
* Gets and sets the theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
getThemeColor() {
}
/**
* Gets and sets the theme color.
* If the foreground color is not a theme color, NULL will be returned.
*/
setThemeColor(value) {
}
/**
* Represents the com.aspose.cells.Color of the line.
*/
getColor() {
}
/**
* Represents the com.aspose.cells.Color of the line.
*/
setColor(value) {
}
/**
* Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Represents the style of the line.
* The value of the property is LineType integer constant.
*/
getStyle() {
}
/**
* Represents the style of the line.
* The value of the property is LineType integer constant.
*/
setStyle(value) {
}
/**
* Gets or sets the WeightType of the line.
* The value of the property is WeightType integer constant.
*/
getWeight() {
}
/**
* Gets or sets the WeightType of the line.
* The value of the property is WeightType integer constant.
*/
setWeight(value) {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
getWeightPt() {
}
/**
* Gets or sets the weight of the line in unit of points.
*/
setWeightPt(value) {
}
/**
* Gets or sets the weight of the line in unit of pixels.
*/
getWeightPx() {
}
/**
* Gets or sets the weight of the line in unit of pixels.
*/
setWeightPx(value) {
}
/**
* Gets or sets format type.
* The value of the property is ChartLineFormattingType integer constant.
*/
getFormattingType() {
}
/**
* Gets or sets format type.
* The value of the property is ChartLineFormattingType integer constant.
*/
setFormattingType(value) {
}
/**
* Indicates whether the color of line is automatic assigned.
*/
isAutomaticColor() {
}
/**
* Represents whether the line is visible.
*/
isVisible() {
}
/**
* Represents whether the line is visible.
*/
setVisible(value) {
}
/**
* Indicates whether this line style is auto assigned.
*/
isAuto() {
}
/**
* Indicates whether this line style is auto assigned.
*/
setAuto(value) {
}
/**
* Represents gradient fill.
*/
getGradientFill() {
}
/**
* Indicates whether Microsoft Workbook automatically determines the intercept of the trendline.
*/
isInterceptAuto() {
}
/**
* Sets whether Microsoft Workbook automatically determines the intercept of the trendline.
*/
setInterceptAuto(isInterceptAuto) {
}
}
/**
* Represents a collection of all the Trendline objects for the specified data series.
* @example
* var chartIndex = excel.getWorksheets().get(0).getCharts().add(aspose.cells.ChartType.COLUMN, 3, 3, 15, 10);
* var chart = excel.getWorksheets().get(0).getCharts().get(chartIndex);
* chart.getNSeries().add("A1:a3", true);
* chart.getNSeries().get(0).getTrendLines().add(aspose.cells.TrendlineType.LINEAR, "MyTrendLine");
* var line = chart.getNSeries().get(0).getTrendLines().get(0);
* line.setDisplayEquation(true);
* line.setDisplayRSquared(true);
* line.setColor(aspose.cells.Color.getRed());
* @hideconstructor
*/
class TrendlineCollection {
/**
*/
getCount() {
}
/**
* Gets a Trendline object by its index.
*/
get(index) {
}
/**
* Adds a Trendline object to this collection with specified type.
* @param {Number} type - TrendlineType
* @return {Number} Trendline object index.
*/
add(type) {
}
/**
* Adds a Trendline object to this collection with specified type and name.
* @param {Number} type - TrendlineType
* @param {String} name - Trendline name.
* @return {Number} Trendline object index.
*/
add(type, name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents two color gradient.
*/
class TwoColorGradient {
/**
* @param {Color} color1
* @param {Color} color2
* @param {Number} gradientStyleType - GradientStyleType
* @param {Number} variant
*/
constructor(color1, color2, gradientStyleType, variant) {
}
/**
* Gets and sets the first gradient color.
*/
getColor1() {
}
/**
* Gets and sets the first gradient color.
*/
setColor1(value) {
}
/**
* Gets and sets the second gradient color.
*/
getColor2() {
}
/**
* Gets and sets the second gradient color.
*/
setColor2(value) {
}
/**
* Gets and sets gradient shading style.
* The value of the property is GradientStyleType integer constant.
*/
getGradientStyleType() {
}
/**
* Gets and sets gradient shading style.
* The value of the property is GradientStyleType integer constant.
*/
setGradientStyleType(value) {
}
/**
* Gets and sets the gradient variant.
*/
getVariant() {
}
/**
* Gets and sets the gradient variant.
*/
setVariant(value) {
}
}
/**
* Represents the options for loading text file.
*/
class TxtLoadOptions {
/**
* Creates the options for loading text file.
* The default load file type is CSV .
*/
constructor() {
}
/**
* Creates the options for loading text file.
* @param {Number} loadFormat - LoadFormat
*/
constructor_overload$1(loadFormat) {
}
/**
* Gets and sets character separator of text file.
*/
getSeparator() {
}
/**
* Gets and sets character separator of text file.
*/
setSeparator(value) {
}
/**
* Gets and sets a string value as separator.
*/
getSeparatorString() {
}
/**
* Gets and sets a string value as separator.
*/
setSeparatorString(value) {
}
/**
* True means that the file contains several encoding.
*/
isMultiEncoded() {
}
/**
* True means that the file contains several encoding.
*/
setMultiEncoded(value) {
}
/**
* Gets and sets preferred value parsers for loading text file.
* parsers[0] is the parser will be used for the first column in text template file,
* parsers[1] is the parser will be used for the second column, ...etc.
* The last one(parsers[parsers.length-1]) will be used for all other columns start from parsers.length-1.
* If one item is null, the corresponding column will be parsed by the default parser of Aspose.Cells.
*/
getPreferredParsers() {
}
/**
* Gets and sets preferred value parsers for loading text file.
* parsers[0] is the parser will be used for the first column in text template file,
* parsers[1] is the parser will be used for the second column, ...etc.
* The last one(parsers[parsers.length-1]) will be used for all other columns start from parsers.length-1.
* If one item is null, the corresponding column will be parsed by the default parser of Aspose.Cells.
*/
setPreferredParsers(value) {
}
/**
* Indicates whether the text is formula if it starts with "=".
*/
hasFormula() {
}
/**
* Indicates whether the text is formula if it starts with "=".
*/
setHasFormula(value) {
}
/**
* Whether there is text qualifier for cell value. Default is true.
*/
hasTextQualifier() {
}
/**
* Whether there is text qualifier for cell value. Default is true.
*/
setHasTextQualifier(value) {
}
/**
* Specifies the text qualifier for cell values. Default qualifier is '"'.
* When setting this property, HasTextQualifier will become true automatically.
*/
getTextQualifier() {
}
/**
* Specifies the text qualifier for cell values. Default qualifier is '"'.
* When setting this property, HasTextQualifier will become true automatically.
*/
setTextQualifier(value) {
}
/**
* Whether consecutive delimiters should be treated as one.
*/
getTreatConsecutiveDelimitersAsOne() {
}
/**
* Whether consecutive delimiters should be treated as one.
*/
setTreatConsecutiveDelimitersAsOne(value) {
}
/**
* 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 Style.QuotePrefix will be set as true for the cell.
*/
getTreatQuotePrefixAsValue() {
}
/**
* 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 Style.QuotePrefix will be set as true for the cell.
*/
setTreatQuotePrefixAsValue(value) {
}
/**
* Whether extends data to next sheet when the rows or columns of data exceed limit.
* Default is false.
* 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() {
}
/**
* Whether extends data to next sheet when the rows or columns of data exceed limit.
* Default is false.
* 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) {
}
/**
* The count of header rows to be repeated for extended sheets.
* The header rows specified by this property will be duplicated for those extended sheets.
* This property only takes effect when ExtendToNextSheet is true.
*/
getHeaderRowsCount() {
}
/**
* The count of header rows to be repeated for extended sheets.
* The header rows specified by this property will be duplicated for those extended sheets.
* This property only takes effect when ExtendToNextSheet is true.
*/
setHeaderRowsCount(value) {
}
/**
* The count of header columns to be repeated for extended sheets.
* The header columns specified by this property will be duplicated for those extended sheets.
* This property only takes effect when ExtendToNextSheet is true.
*/
getHeaderColumnsCount() {
}
/**
* The count of header columns to be repeated for extended sheets.
* The header columns specified by this property will be duplicated for those extended sheets.
* This property only takes effect when ExtendToNextSheet is true.
*/
setHeaderColumnsCount(value) {
}
/**
* The maximum count of rows to be imported for one sheet.
* Those rows exceeding this limit will be ignored
* or extended to next sheet according to ExtendToNextSheet.
* This count includes the header rows(HeaderRowsCount).
* 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() {
}
/**
* The maximum count of rows to be imported for one sheet.
* Those rows exceeding this limit will be ignored
* or extended to next sheet according to ExtendToNextSheet.
* This count includes the header rows(HeaderRowsCount).
* 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) {
}
/**
* The maximum count of columns to be imported for one sheet.
* Those columns exceeding this limit will be ignored
* or extended to next sheet according to ExtendToNextSheet.
* This count includes the header columns(HeaderColumnsCount).
* 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() {
}
/**
* The maximum count of columns to be imported for one sheet.
* Those columns exceeding this limit will be ignored
* or extended to next sheet according to ExtendToNextSheet.
* This count includes the header columns(HeaderColumnsCount).
* 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) {
}
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
getEncoding() {
}
/**
* Gets and sets the default encoding. Only applies for csv file.
*/
setEncoding(value) {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
getLoadStyleStrategy() {
}
/**
* Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
* The value of the property is TxtLoadStyleStrategy integer constant.
*/
setLoadStyleStrategy(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
getConvertNumericData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to numeric data.
*/
setConvertNumericData(value) {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
getConvertDateTimeData() {
}
/**
* Gets or sets a value that indicates whether the string in text file is converted to date data.
*/
setConvertDateTimeData(value) {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
getKeepPrecision() {
}
/**
* Indicates whether not parsing a string value if the length is 15.
*/
setKeepPrecision(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents the save options for csv/tab delimited/other text format.
*/
class TxtSaveOptions {
/**
* Creates text file save options.
*/
constructor() {
}
/**
* Creates text file save options.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Gets and sets char Delimiter of text file.
*/
getSeparator() {
}
/**
* Gets and sets char Delimiter of text file.
*/
setSeparator(value) {
}
/**
* Gets and sets a string value as separator.
*/
getSeparatorString() {
}
/**
* Gets and sets a string value as separator.
*/
setSeparatorString(value) {
}
/**
* Gets and sets the default encoding.
*/
getEncoding() {
}
/**
* Gets and sets the default encoding.
*/
setEncoding(value) {
}
/**
* Indicates whether always adding '"' for each field.
* If true then all values will be quoted;
* If false then values will only be quoted when needed(for example,
* when values contain special characters such as '"' , '\n' or separator character).
* Default is false.
* NOTE: This member is now obsolete. Instead,
* please use QuoteType property instead.
* This property will be removed 12 months later since August 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getAlwaysQuoted() {
}
/**
* Indicates whether always adding '"' for each field.
* If true then all values will be quoted;
* If false then values will only be quoted when needed(for example,
* when values contain special characters such as '"' , '\n' or separator character).
* Default is false.
* NOTE: This member is now obsolete. Instead,
* please use QuoteType property instead.
* This property will be removed 12 months later since August 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setAlwaysQuoted(value) {
}
/**
* Gets or sets how to quote values in the exported text file.
* The value of the property is TxtValueQuoteType integer constant.
*/
getQuoteType() {
}
/**
* Gets or sets how to quote values in the exported text file.
* The value of the property is TxtValueQuoteType integer constant.
*/
setQuoteType(value) {
}
/**
* Gets and sets the format strategy when exporting the cell value as string.
* The value of the property is CellValueFormatStrategy integer constant.
*/
getFormatStrategy() {
}
/**
* Gets and sets the format strategy when exporting the cell value as string.
* The value of the property is CellValueFormatStrategy integer constant.
*/
setFormatStrategy(value) {
}
/**
* The data provider for saving workbook in light mode.
*/
getLightCellsDataProvider() {
}
/**
* The data provider for saving workbook in light mode.
*/
setLightCellsDataProvider(value) {
}
/**
* Indicates whether leading blank rows and columns should be trimmed like what ms excel does.
* Default is true.
* Same with the rule in ms excel, a row/column will not be taken as blank if it has custom style,
* even if it contains no cell data.
* When saving with LightCells mode, this option takes no effect.
* User should control the output range by the implementation of LightCellsDataProvider
* or by speicifing ExportArea
*/
getTrimLeadingBlankRowAndColumn() {
}
/**
* Indicates whether leading blank rows and columns should be trimmed like what ms excel does.
* Default is true.
* Same with the rule in ms excel, a row/column will not be taken as blank if it has custom style,
* even if it contains no cell data.
* When saving with LightCells mode, this option takes no effect.
* User should control the output range by the implementation of LightCellsDataProvider
* or by speicifing ExportArea
*/
setTrimLeadingBlankRowAndColumn(value) {
}
/**
* Indicates whether tailing blank cells in one row should be trimmed. Default is false.
* When saving with LightCells mode and the ExportArea has not been specified,
* this option takes no effect and one row will be extended to just the last cell provided by
* the implementation LightCellsDataProvider
*/
getTrimTailingBlankCells() {
}
/**
* Indicates whether tailing blank cells in one row should be trimmed. Default is false.
* When saving with LightCells mode and the ExportArea has not been specified,
* this option takes no effect and one row will be extended to just the last cell provided by
* the implementation LightCellsDataProvider
*/
setTrimTailingBlankCells(value) {
}
/**
* Indicates whether separators should be output for blank row.
* Default value is false so by default the content for blank row will be empty.
*/
getKeepSeparatorsForBlankRow() {
}
/**
* Indicates whether separators should be output for blank row.
* Default value is false so by default the content for blank row will be empty.
*/
setKeepSeparatorsForBlankRow(value) {
}
/**
* The range of cells to be exported.
* If the exported area has been specified, TrimLeadingBlankRowAndColumn
* will takes no effect.
*/
getExportArea() {
}
/**
* The range of cells to be exported.
* If the exported area has been specified, TrimLeadingBlankRowAndColumn
* will takes no effect.
*/
setExportArea(value) {
}
/**
* Indicates whether the single quote sign should be exported as part of the value of one cell
* when Style.QuotePrefix is true for it. Default is false.
*/
getExportQuotePrefix() {
}
/**
* Indicates whether the single quote sign should be exported as part of the value of one cell
* when Style.QuotePrefix is true for it. Default is false.
*/
setExportQuotePrefix(value) {
}
/**
* Indicates whether exporting all sheets to the text file.
* If it is false, only export the activesheet, just like MS Excel.
* The defult value is false.
*/
getExportAllSheets() {
}
/**
* Indicates whether exporting all sheets to the text file.
* If it is false, only export the activesheet, just like MS Excel.
* The defult value is false.
*/
setExportAllSheets(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents union range.
* @hideconstructor
*/
class UnionRange {
/**
* Gets the index of the first row of the range.
* Only effects when it only contains one range.
*/
getFirstRow() {
}
/**
* Gets the index of the first column of the range.
* Only effects when it only contains one range.
*/
getFirstColumn() {
}
/**
* Gets the count of rows in the range.
* Only effects when it only contains one range.
*/
getRowCount() {
}
/**
* Gets the count of rows in the range.
* Only effects when it only contains one range.
*/
getColumnCount() {
}
/**
* Gets and sets the values of the range.
*/
getValue() {
}
/**
* Gets and sets the values of the range.
*/
setValue(value) {
}
/**
* Gets or sets the name of the range.
* Named range is supported. For example,
* range.Name = "Sheet1!MyRange";
*/
getName() {
}
/**
* Gets or sets the name of the range.
* Named range is supported. For example,
* range.Name = "Sheet1!MyRange";
*/
setName(value) {
}
/**
* Gets the range's refers to.
*/
getRefersTo() {
}
/**
* Indicates whether this has range.
*/
hasRange() {
}
/**
* Gets all hyperlink in the range.
*/
getHyperlinks() {
}
/**
* Gets all cell count in the range.
*/
getCellCount() {
}
/**
* Gets the count of the ranges.
*/
getRangeCount() {
}
/**
* Gets all union ranges.
*/
getRanges() {
}
/**
* Combines a range of cells into a single cell.
* Reference the merged cell via the address of the upper-left cell in the range.
*/
merge() {
}
/**
* Unmerges merged cells of this range.
*/
unMerge() {
}
/**
* 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 {String} stringValue - Input value
* @param {boolean} isConverted - True: converted to other data type if appropriate.
* @param {boolean} setStyle - True: set the number format to cell's style when converting to other data type
*/
putValue(stringValue, isConverted, setStyle) {
}
/**
* Sets the style of the range.
* @param {Style} style - The Style object.
*/
setStyle(style) {
}
/**
* Applies formats for a whole range.
* Each cell in this range will contains a Style object.
* So this is a memory-consuming method. Please use it carefully.
* @param {Style} style - The style object which will be applied.
* @param {StyleFlag} flag - Flags which indicates applied formatting properties.
*/
applyStyle(style, flag) {
}
/**
* Copying the range with paste special options.
* @param {UnionRange} range - The source range.
* @param {PasteOptions} options - The paste special options.
*/
copy(range, options) {
}
/**
* Gets the enumerator for cells in this Range.
* 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).@return {Iterator} The cells enumerator
*/
iterator() {
}
/**
* Sets out line borders around a range of cells.
* Both the length of borderStyles and borderStyles must be 4.
* The order of borderStyles and borderStyles must be top,bottom,left,right
* @param {Number[]} borderStyles - Border styles.
* @param {Color[]} borderColors - Border colors.
*/
setOutlineBorders(borderStyles, borderColors) {
}
/**
* Sets the outline borders around a range of cells with same border style and color.
* @param {Number} borderStyle - CellBorderType
* @param {Color} borderColor - Border color.
*/
setOutlineBorders(borderStyle, borderColor) {
}
/**
* Intersects another range.
* If the two union ranges are not intersected, returns null.
* @param {String} range - The range.
*/
intersect(range) {
}
/**
* Intersects another range.
* If the two union ranges are not intersected, returns null.
* @param {UnionRange} unionRange - The range.
*/
intersect(unionRange) {
}
/**
* Intersects another range.
* If the two union ranges are not intersected, returns null.
* @param {Range[]} ranges - The range.
*/
intersect(ranges) {
}
/**
* Union another range.
* @param {String} range - The range.
* @return {UnionRange}
*/
union(range) {
}
/**
* Union another range.
* @param {UnionRange} unionRange - The range.
* @return {UnionRange}
*/
union(unionRange) {
}
/**
* Union the ranges.
* @param {Range[]} ranges - The ranges.
* @return {UnionRange}
*/
union(ranges) {
}
}
/**
* Equation node class of unknown type
* @hideconstructor
*/
class UnknowEquationNode {
/**
* Specifies the parent node of the current node
*/
getParentNode() {
}
/**
* Specifies the parent node of the current node
*/
setParentNode(value) {
}
/**
* Represents the type of the node.
* The value of the property is TextNodeType integer constant.
*/
getType() {
}
/**
* Get the equation type of the current node
* The value of the property is EquationNodeType integer constant.
*/
getEquationType() {
}
/**
* Gets the start index of the characters.
*/
getStartIndex() {
}
/**
* Gets the length of the characters.
*/
getLength() {
}
/**
* Returns the font of this object.
*/
getFont() {
}
/**
* Returns the text options.
*/
getTextOptions() {
}
/**
* Determine whether the current equation node is equal to the specified node
* @param {Object} obj - The specified node
* @return {boolean}
*/
equals(obj) {
}
/**
* Insert a node of the specified type at the end of the child node list of the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node at the end of the current node's list of child nodes.
* @param {EquationNode} node - The specified node
*/
addChild(node) {
}
/**
* Inserts a node of the specified type at the specified index position in the current node's child node list.
* @param {Number} index - index value
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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, equationType) {
}
/**
* Inserts the specified node after the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Inserts the specified node before the current node.
* @param {Number} equationType - EquationNodeType
* @return {EquationNode} 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) {
}
/**
* Returns the node at the specified index among the children of the current node.
* @param {Number} index - Index of the node
* @return {EquationNode} Returns the corresponding node if the specified node exists, otherwise returns null.
*/
getChild(index) {
}
/**
* Removes itself from the parent.
*/
remove() {
}
/**
* Removes the specified node from the current node's children.
* @param {EquationNode} node - Node to be deleted.
*/
removeChild(node) {
}
/**
* Removes the node at the specified index from the current node's children.
* @param {Number} index - Index of the node
*/
removeChild(index) {
}
/**
* Removes all the child nodes of the current node.
*/
removeAllChildren() {
}
/**
* Sets the preset WordArt style.
* Only for the text of shape/chart.
* @param {Number} style - PresetWordArtStyle
*/
setWordArtStyle(style) {
}
}
/**
* Unknow control.
* @hideconstructor
*/
class UnknownControl {
/**
* Gets and sets the binary data of the control.
*/
getData() {
}
/**
* Gets the type of the ActiveX control.
* The value of the property is ControlType integer constant.
*/
getType() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
isEnabled() {
}
/**
* Indicates whether the control can receive the focus and respond to user-generated events.
*/
setEnabled(value) {
}
/**
* Indicates whether data in the control is locked for editing.
*/
isLocked() {
}
/**
* Indicates whether data in the control is locked for editing.
*/
setLocked(value) {
}
/**
* Indicates whether the control is transparent.
*/
isTransparent() {
}
/**
* Indicates whether the control is transparent.
*/
setTransparent(value) {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
isAutoSize() {
}
/**
* Indicates whether the control will automatically resize to display its entire contents.
*/
setAutoSize(value) {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
getIMEMode() {
}
/**
* Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
* The value of the property is InputMethodEditorMode integer constant.
*/
setIMEMode(value) {
}
/**
* Represents the font of the control.
*/
getFont() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
getTextAlign() {
}
/**
* Represents how to align the text used by the control.
* The value of the property is TextAlignmentType integer constant.
*/
setTextAlign(value) {
}
/**
* Gets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
getWidth() {
}
/**
* Gets and sets the width of the control in unit of points.
*/
setWidth(value) {
}
/**
* Gets and sets the height of the control in unit of points.
*/
getHeight() {
}
/**
* Gets and sets the height of the control in unit of points.
*/
setHeight(value) {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
getMouseIcon() {
}
/**
* Gets and sets a custom icon to display as the mouse pointer for the control.
*/
setMouseIcon(value) {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
getMousePointer() {
}
/**
* Gets and sets the type of icon displayed as the mouse pointer for the control.
* The value of the property is ControlMousePointerType integer constant.
*/
setMousePointer(value) {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
getForeOleColor() {
}
/**
* Gets and sets the ole color of the foreground.
* Not applies to Image control.
*/
setForeOleColor(value) {
}
/**
* Gets and sets the ole color of the background.
*/
getBackOleColor() {
}
/**
* Gets and sets the ole color of the background.
*/
setBackOleColor(value) {
}
/**
* Indicates whether this control is visible.
*/
isVisible() {
}
/**
* Indicates whether this control is visible.
*/
setVisible(value) {
}
/**
* Indicates whether to show a shadow.
*/
getShadow() {
}
/**
* Indicates whether to show a shadow.
*/
setShadow(value) {
}
/**
* Gets and sets the linked cell.
*/
getLinkedCell() {
}
/**
* Gets and sets the linked cell.
*/
setLinkedCell(value) {
}
/**
* Gets and sets the list fill range.
*/
getListFillRange() {
}
/**
* Gets and sets the list fill range.
*/
setListFillRange(value) {
}
/**
* Gets the related data.
* @param {String} relId - The relationship id.
* @return {byte[]} Returns the related data.
*/
getRelationshipData(relId) {
}
}
/**
* Represents data validation.settings.
* @example
* var workbook = new aspose.cells.Workbook();
* var validations = workbook.getWorksheets().get(0).getValidations();
* var validation = validations.get(validations.add());
* validation.setType(aspose.cells.ValidationType.WHOLE_NUMBER);
* validation.setOperator(aspose.cells.OperatorType.BETWEEN);
* validation.setFormula1("3");
* validation.setFormula2("1234");
* var area = new aspose.cells.CellArea();
* area.StartRow = 0;
* area.EndRow = 1;
* area.StartColumn = 0;
* area.EndColumn = 1;
* validation.addArea(area);
* @hideconstructor
*/
class Validation {
/**
* Represents the operator for the data validation.
* The value of the property is OperatorType integer constant.
*/
getOperator() {
}
/**
* Represents the operator for the data validation.
* The value of the property is OperatorType integer constant.
*/
setOperator(value) {
}
/**
* Represents the validation alert style.
* The value of the property is ValidationAlertType integer constant.
*/
getAlertStyle() {
}
/**
* Represents the validation alert style.
* The value of the property is ValidationAlertType integer constant.
*/
setAlertStyle(value) {
}
/**
* Represents the data validation type.
* The value of the property is ValidationType integer constant.
*/
getType() {
}
/**
* Represents the data validation type.
* The value of the property is ValidationType integer constant.
*/
setType(value) {
}
/**
* Represents the data validation input message.
*/
getInputMessage() {
}
/**
* Represents the data validation input message.
*/
setInputMessage(value) {
}
/**
* Represents the title of the data-validation input dialog box.
*/
getInputTitle() {
}
/**
* Represents the title of the data-validation input dialog box.
*/
setInputTitle(value) {
}
/**
* Represents the data validation error message.
*/
getErrorMessage() {
}
/**
* Represents the data validation error message.
*/
setErrorMessage(value) {
}
/**
* Represents the title of the data-validation error dialog box.
*/
getErrorTitle() {
}
/**
* Represents the title of the data-validation error dialog box.
*/
setErrorTitle(value) {
}
/**
* Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.
*/
getShowInput() {
}
/**
* Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.
*/
setShowInput(value) {
}
/**
* Indicates whether the data validation error message will be displayed whenever the user enters invalid data.
*/
getShowError() {
}
/**
* Indicates whether the data validation error message will be displayed whenever the user enters invalid data.
*/
setShowError(value) {
}
/**
* Indicates whether blank values are permitted by the range data validation.
*/
getIgnoreBlank() {
}
/**
* Indicates whether blank values are permitted by the range data validation.
*/
setIgnoreBlank(value) {
}
/**
* Represents the value or expression associated with the data validation.
*/
getFormula1() {
}
/**
* Represents the value or expression associated with the data validation.
*/
setFormula1(value) {
}
/**
* Represents the value or expression associated with the data validation.
*/
getFormula2() {
}
/**
* Represents the value or expression associated with the data validation.
*/
setFormula2(value) {
}
/**
* Represents the first value associated with the data validation.
*/
getValue1() {
}
/**
* Represents the first value associated with the data validation.
*/
setValue1(value) {
}
/**
* Represents the second value associated with the data validation.
*/
getValue2() {
}
/**
* Represents the second value associated with the data validation.
*/
setValue2(value) {
}
/**
* Indicates whether data validation displays a drop-down list that contains acceptable values.
*/
getInCellDropDown() {
}
/**
* Indicates whether data validation displays a drop-down list that contains acceptable values.
*/
setInCellDropDown(value) {
}
/**
* Gets all CellArea which contain the data validation settings.
*/
getAreas() {
}
/**
* Gets the value or expression associated with this validation.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The value or expression associated with this validation.
*/
getFormula1(isR1C1, isLocal) {
}
/**
* Gets the value or expression associated with this validation.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The value or expression associated with this validation.
*/
getFormula2(isR1C1, isLocal) {
}
/**
* Gets the value or expression associated with this validation for specific cell.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {String} The value or expression associated with this validation.
*/
getFormula1(isR1C1, isLocal, row, column) {
}
/**
* Gets the value or expression associated with this validation for specific cell.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {String} The value or expression associated with this validation.
*/
getFormula2(isR1C1, isLocal, row, column) {
}
/**
* Sets the value or expression associated with this validation.
* @param {String} formula - The value or expression associated with this format condition.
* @param {boolean} isR1C1 - Whether the formula is R1C1 formula.
* @param {boolean} isLocal - Whether the formula is locale formatted.
*/
setFormula1(formula, isR1C1, isLocal) {
}
/**
* Sets the value or expression associated with this validation.
* @param {String} formula - The value or expression associated with this format condition.
* @param {boolean} isR1C1 - Whether the formula is R1C1 formula.
* @param {boolean} isLocal - Whether the formula is locale formatted.
*/
setFormula2(formula, isR1C1, isLocal) {
}
/**
* Get the value for list of the validation for the specified cell.
* Only for validation whose type is List and has been applied to given cell,
* otherwise null will be returned.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {Object} 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 ReferredArea object;
* Otherwise the returned value may be null, object[], or simple object.
*/
getListValue(row, column) {
}
/**
* Get the value of validation on the specific cell.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @param {boolean} isValue1 - Indicates whether getting the first value.
* @return {Object}
*/
getValue(row, column, isValue1) {
}
/**
* Applies the validation to the area.
* It is equivalent to use addArea(com.aspose.cells.CellArea, boolean, boolean)
* with checking intersection and edge.
* @param {CellArea} cellArea - The area.
*/
addArea(cellArea) {
}
/**
* Applies the validation to the area.
* 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.
* @param {CellArea} cellArea - The area.
* @param {boolean} 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 {boolean} 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.
*/
addArea(cellArea, checkIntersection, checkEdge) {
}
/**
* Applies the validation to given areas.
* 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.
* @param {CellArea[]} areas - The areas.
* @param {boolean} 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 {boolean} 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.
*/
addAreas(areas, checkIntersection, checkEdge) {
}
/**
* Remove the validation settings in the range.
* @param {CellArea} cellArea - the areas where this validation settings should be removed.
*/
removeArea(cellArea) {
}
/**
* Removes this validation from given areas.
* @param {CellArea[]} areas - the areas where this validation settings should be removed.
*/
removeAreas(areas) {
}
/**
* Remove the validation settings in the cell.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
*/
removeACell(row, column) {
}
/**
* Copy validation.
* @param {Validation} source - The source validation.
* @param {CopyOptions} copyOption - The copy option.
*/
copy(source, copyOption) {
}
}
/**
* Represents data validation collection.
* @hideconstructor
*/
class ValidationCollection {
/**
*/
getCount() {
}
/**
* Gets the Validation element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Validation} The element at the specified index.
*/
get(index) {
}
/**
* Adds a data validation to the collection.
* NOTE: This member is now obsolete. Instead,
* please use ValidationCollection.Add(CellArea) method.
* This property will be removed 12 months later since JANUARY 2015.
* Aspose apologizes for any inconvenience you may have experienced.@return {Number} Validation object index.
*/
add() {
}
/**
* Adds a data validation to the collection.
* @param {CellArea} ca - The area contains this validation.
* @return {Number} Validation object index.
*/
add(ca) {
}
/**
* Removes all validation setting on the cell.
* @param {Number} row - The row index of the cell.
* @param {Number} column - The column index of the cell.
*/
removeACell(row, column) {
}
/**
* Removes all validation setting on the range..
* @param {CellArea} ca - The range which contains the validations setting.
*/
removeArea(ca) {
}
/**
* Gets the validation applied to given cell.
* @param {Number} row - The row index.
* @param {Number} column - The column index.
* @return {Validation} Returns a Validation object or null if there is no validation for given cell
*/
getValidationInCell(row, column) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the module in VBA project.
* @hideconstructor
*/
class VbaModule {
/**
* Gets and sets the name of Module.
*/
getName() {
}
/**
* Gets and sets the name of Module.
*/
setName(value) {
}
/**
* Gets the type of module.
* The value of the property is VbaModuleType integer constant.
*/
getType() {
}
/**
* Gets and sets the codes of module.
*/
getCodes() {
}
/**
* Gets and sets the codes of module.
*/
setCodes(value) {
}
}
/**
* Represents the list of VbaModule
* @hideconstructor
*/
class VbaModuleCollection {
/**
*/
getCount() {
}
/**
* Gets VbaModule in the list by the index.
* @param {Number} index - The index.
* @return {VbaModule}
*/
get(index) {
}
/**
* Gets VbaModule in the list by the name.
* @param {String} name - The name of module.
* @return {VbaModule}
*/
get(name) {
}
/**
* @param {String} name
* @param {byte[]} data
*/
addDesignerStorage(name, data) {
}
/**
* Represents the data of Designer.
* We do not support to parse them. Just only for copying.
*/
getDesignerStorage(name) {
}
/**
* Adds module for a worksheet.
* @param {Worksheet} sheet - The worksheet
* @return {Number}
*/
add(sheet) {
}
/**
* Adds module.
* @param {Number} type - VbaModuleType
* @param {String} name - The name of module.
* @return {Number}
*/
add(type, name) {
}
/**
* Inser user form into VBA Project.
* @param {String} name - The name of user form
* @param {String} codes - The codes for the user form
* @param {byte[]} designerStorage - the designer setting about the user form
* @return {Number}
*/
addUserForm(name, codes, designerStorage) {
}
/**
* Removes module for a worksheet.
* @param {Worksheet} sheet - The worksheet
* @return {void}
*/
remove(sheet) {
}
/**
* Remove the module by the name
* @param {String} name
*/
remove(name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the VBA project.
* @hideconstructor
*/
class VbaProject {
/**
* Indicates whether the signature of VBA project is valid or not.
*/
isValidSigned() {
}
/**
* Gets certificate raw data if this VBA project is signed.
*/
getCertRawData() {
}
/**
* Gets and sets the encoding of VBA project.
*/
getEncoding() {
}
/**
* Gets and sets the encoding of VBA project.
*/
setEncoding(value) {
}
/**
* Gets and sets the name of the VBA project.
*/
getName() {
}
/**
* Gets and sets the name of the VBA project.
*/
setName(value) {
}
/**
* Indicates whether VBAcode is signed or not.
*/
isSigned() {
}
/**
* Indicates whether this VBA project is protected.
*/
isProtected() {
}
/**
* Indicates whether this VBA project is locked for viewing.
*/
getIslockedForViewing() {
}
/**
* Gets all VbaModule objects.
*/
getModules() {
}
/**
* Gets all references of VBA project.
*/
getReferences() {
}
/**
* Sign this VBA project by a DigitalSignature
* @param {DigitalSignature} digitalSignature - DigitalSignature
*/
sign(digitalSignature) {
}
/**
* Protects or unprotects this VBA project.
* If islockedForViewing is true, the password could not be null.
* @param {boolean} islockedForViewing - indicates whether locks project for viewing.
* @param {String} password -
* If the value is null, unprotects this VBA project, otherwise projects the this VBA project.
*/
protect(islockedForViewing, password) {
}
/**
* Copy VBA project from other file.
* @param {VbaProject} source
*/
copy(source) {
}
/**
* Validates protection password.
* @param {String} password - the password
* @return {boolean} Whether password is the protection password of this VBA project
*/
validatePassword(password) {
}
}
/**
* Represents the reference of VBA project.
* @hideconstructor
*/
class VbaProjectReference {
/**
* Gets the type of this reference.
* The value of the property is VbaProjectReferenceType integer constant.
*/
getType() {
}
/**
* Gets and sets the name of the reference.
*/
getName() {
}
/**
* Gets and sets the name of the reference.
*/
setName(value) {
}
/**
* Gets and sets the Libid of the reference.
*/
getLibid() {
}
/**
* Gets and sets the Libid of the reference.
*/
setLibid(value) {
}
/**
* Gets and sets the twiddled Libid of the reference.
* Only for control reference.
*/
getTwiddledlibid() {
}
/**
* Gets and sets the twiddled Libid of the reference.
* Only for control reference.
*/
setTwiddledlibid(value) {
}
/**
* Gets and sets the extended Libid of the reference.
* Only for control reference.
*/
getExtendedLibid() {
}
/**
* Gets and sets the extended Libid of the reference.
* Only for control reference.
*/
setExtendedLibid(value) {
}
/**
* Gets and sets the referenced VBA project's identifier with an relative path.
* Only for project reference.
*/
getRelativeLibid() {
}
/**
* Gets and sets the referenced VBA project's identifier with an relative path.
* Only for project reference.
*/
setRelativeLibid(value) {
}
/**
* @param {VbaProjectReference} source
*/
copy(source) {
}
}
/**
* Represents all references of VBA project.
* @hideconstructor
*/
class VbaProjectReferenceCollection {
/**
*/
getCount() {
}
/**
* Get the reference in the list by the index.
* @param {Number} i - The index.
* @return {VbaProjectReference}
*/
get(i) {
}
/**
* Add a reference to an Automation type library.
* @param {String} name - The name of reference.
* @param {String} libid - The identifier of an Automation type library.
* @return {Number}
*/
addRegisteredReference(name, libid) {
}
/**
* Add a reference to a twiddled type library and its extended type library.
* @param {String} name - The name of reference.
* @param {String} libid - The identifier of an Automation type library.
* @param {String} twiddledlibid - The identifier of a twiddled type library
* @param {String} extendedLibid - The identifier of an extended type library
* @return {Number}
*/
addControlRefrernce(name, libid, twiddledlibid, extendedLibid) {
}
/**
* Adds a reference to an external VBA project.
* @param {String} name - The name of reference.
* @param {String} absoluteLibid - The referenced VBA project's identifier with an absolute path.
* @param {String} relativeLibid - The referenced VBA project's identifier with an relative path.
* @return {Number}
*/
addProjectRefrernce(name, absoluteLibid, relativeLibid) {
}
/**
* Copies references from other VBA project.
* @param {VbaProjectReferenceCollection} source - The source references.
*/
copy(source) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Encapsulates the object that represents a vertical page break.
* @example
* //Add a pagebreak at G5
* excel.getWorksheets().get(0).getHorizontalPageBreaks().add("G5");
* excel.getWorksheets().get(0).getVerticalPageBreaks().add("G5");
* @hideconstructor
*/
class VerticalPageBreak {
/**
* Gets the start row index of the vertical page break.
*/
getStartRow() {
}
/**
* Gets the end row index of the vertical page break.
*/
getEndRow() {
}
/**
* Gets the column index of the vertical page break.
*/
getColumn() {
}
}
/**
* Encapsulates a collection of VerticalPageBreak objects.
* @hideconstructor
*/
class VerticalPageBreakCollection {
/**
*/
getCount() {
}
/**
* Gets the VerticalPageBreak element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {VerticalPageBreak} The element at the specified index.
*/
get(index) {
}
/**
* Gets the VerticalPageBreak element with the specified cell name.
* @param {String} cellName - Cell name.
* @return {VerticalPageBreak} The element with the specified cell name.
*/
get(cellName) {
}
/**
* Adds a vertical page break to the collection.
* This method is used to add a vertical pagebreak within a print area.
* @param {Number} startRow - Start row index, zero based.
* @param {Number} endRow - End row index, zero based.
* @param {Number} column - Column index, zero based.
* @return {Number} VerticalPageBreak object index.
*/
add(startRow, endRow, column) {
}
/**
* Adds a vertical page break to the collection.
* Page break is added in the top left of the cell.
* Please set a horizontal page break and a vertical page break concurrently.
* @param {Number} column - Cell column index, zero based.
* @return {Number} VerticalPageBreak object index.
*/
add(column) {
}
/**
* Adds a vertical page break to the collection.
* Page break is added in the top left of the cell.
* Please set a horizontal page break and a vertical page break concurrently.
* @param {Number} row - Cell row index, zero based.
* @param {Number} column - Cell column index, zero based.
* @return {Number} VerticalPageBreak object index.
*/
add(row, column) {
}
/**
* Adds a vertical page break to the collection.
* Page break is added in the top left of the cell.
* Please set a horizontal page break and a vertical page break concurrently.
* @param {String} cellName - Cell name.
* @return {Number} VerticalPageBreak object index.
*/
add(cellName) {
}
/**
* Removes the VPageBreak element at a specified name.
* @param {Number} index - Element index, zero based.
*/
removeAt(index) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* 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
* @hideconstructor
*/
class VmlShapeGuide {
}
/**
* Encapsulates the object that represents the walls of a 3-D chart.
* @hideconstructor
*/
class Walls {
/**
* Gets the x coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's width after calls Chart.Calculate() method.
*/
getCenterX() {
}
/**
* Gets the y coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's height after calls Chart.Calculate() method.
*/
getCenterY() {
}
/**
* Gets the width of left to right in units of 1/4000 of chart's width after calls Chart.Calculate() method.
*/
getWidth() {
}
/**
* Gets the depth front to back in units of 1/4000 of chart's width after calls Chart.Calculate() method.
*/
getDepth() {
}
/**
* Gets the height of top to bottom in units of 1/4000 of chart's height after calls Chart.Calculate() method.
*/
getHeight() {
}
/**
* Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
*/
getCenterXPx() {
}
/**
* Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
*/
getCenterYPx() {
}
/**
* Gets the width of left to right in units of pixels after calls Chart.Calculate() method.
*/
getWidthPx() {
}
/**
* Gets the depth front to back in units of pixels after calls Chart.Calculate() method.
*/
getDepthPx() {
}
/**
* Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method.
*/
getHeightPx() {
}
/**
* Gets or sets the border Line.
*/
getBorder() {
}
/**
* Gets or sets the border Line.
*/
setBorder(value) {
}
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
getBackgroundColor() {
}
/**
* Gets or sets the background com.aspose.cells.Color of the Area.
*/
setBackgroundColor(value) {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
getForegroundColor() {
}
/**
* Gets or sets the foreground com.aspose.cells.Color.
*/
setForegroundColor(value) {
}
/**
* Represents the formatting of the area.
* The value of the property is FormattingType integer constant.
*/
getFormatting() {
}
/**
* Represents the formatting of the area.
* The value of the property is FormattingType integer constant.
*/
setFormatting(value) {
}
/**
* If the property is true and the value of chart point is a negative number,
* the foreground color and background color will be exchanged.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(-100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "A3"
* chart.getNSeries().add("A1:A3", true);
* chart.getNSeries().get(0).getArea().setInvertIfNegative(true);
* //Setting the foreground color of the 1st NSeries area
* chart.getNSeries().get(0).getArea().setForegroundColor(aspose.cells.Color.getRed());
* //Setting the background color of the 1st NSeries area.
* //The displayed area color of second chart point will be the background color.
* chart.getNSeries().get(0).getArea().setBackgroundColor(aspose.cells.Color.getYellow());
* //Saving the Excel file
* workbook.save("C:\\book1.xls");
*/
getInvertIfNegative() {
}
/**
* If the property is true and the value of chart point is a negative number,
* the foreground color and background color will be exchanged.
* @example
* //Instantiating a Workbook object
* var workbook = new aspose.cells.Workbook();
* //Adding a new worksheet to the Workbook object
* var sheetIndex = workbook.getWorksheets().add();
* //Obtaining the reference of the newly added worksheet by passing its sheet index
* var worksheet = workbook.getWorksheets().get(sheetIndex);
* //Adding a sample value to "A1" cell
* worksheet.getCells().get("A1").putValue(50);
* //Adding a sample value to "A2" cell
* worksheet.getCells().get("A2").putValue(-100);
* //Adding a sample value to "A3" cell
* worksheet.getCells().get("A3").putValue(150);
* //Adding a chart to the worksheet
* var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
* //Accessing the instance of the newly added chart
* var chart = worksheet.getCharts().get(chartIndex);
* //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "A3"
* chart.getNSeries().add("A1:A3", true);
* chart.getNSeries().get(0).getArea().setInvertIfNegative(true);
* //Setting the foreground color of the 1st NSeries area
* chart.getNSeries().get(0).getArea().setForegroundColor(aspose.cells.Color.getRed());
* //Setting the background color of the 1st NSeries area.
* //The displayed area color of second chart point will be the background color.
* chart.getNSeries().get(0).getArea().setBackgroundColor(aspose.cells.Color.getYellow());
* //Saving the Excel file
* workbook.save("C:\\book1.xls");
*/
setInvertIfNegative(value) {
}
/**
* Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
*/
getFillFormat() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
getTransparency() {
}
/**
* Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
*/
setTransparency(value) {
}
/**
* Gets the number of cube points after calls Chart.Calculate() method.
*/
getCubePointCount() {
}
/**
* Gets x-coordinate of the apex point of walls cube after calls Chart.Calculate() method.
* The number of apex points of walls cube is eight
*/
getCubePointXPx(index) {
}
/**
* Gets y-coordinate of the apex point of walls cube after calls Chart.Calculate() method.
* The number of apex points of walls cube is eight.
*/
getCubePointYPx(index) {
}
}
/**
* Represents an Office Add-in instance.
* @hideconstructor
*/
class WebExtension {
/**
* Gets and sets the uniquely identifies the Office Add-in instance in the current document.
*/
getId() {
}
/**
* Gets and sets the uniquely identifies the Office Add-in instance in the current document.
*/
setId(value) {
}
/**
* Indicates whether the user can interact with the Office Add-in or not.
*/
isFrozen() {
}
/**
* Indicates whether the user can interact with the Office Add-in or not.
*/
setFrozen(value) {
}
/**
* Get the primary reference to an Office Add-in.
*/
getReference() {
}
/**
* Gets a list of alter references.
*/
getAlterReferences() {
}
/**
* Gets all properties of web extension.
*/
getProperties() {
}
/**
* Gets all bindings relationship between an Office Add-in and the data in the document.
*/
getBindings() {
}
}
/**
* Represents a binding relationship between an Office Add-in and the data in the document.
*/
class WebExtensionBinding {
/**
*/
constructor() {
}
/**
* Gets and sets the binding identifier.
*/
getId() {
}
/**
* Gets and sets the binding identifier.
*/
setId(value) {
}
/**
* Gets and sets the binding type.
*/
getType() {
}
/**
* Gets and sets the binding type.
*/
setType(value) {
}
/**
* Gets and sets the binding key used to map the binding entry in this list with the bound data in the document.
*/
getAppref() {
}
/**
* Gets and sets the binding key used to map the binding entry in this list with the bound data in the document.
*/
setAppref(value) {
}
}
/**
* Represents the list of binding relationships between an Office Add-in and the data in the document.
*/
class WebExtensionBindingCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets web extension binding relationship by the specific index.
* @param {Number} index - The index.
* @return {WebExtensionBinding} The web extension binding relationship
*/
get(index) {
}
/**
* Adds an a binding relationship between an Office Add-in and the data in the document.
* @return {Number}
*/
add() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the list of web extension.
* @hideconstructor
*/
class WebExtensionCollection {
/**
*/
getCount() {
}
/**
* Gets web extension by the specific index.
* @param {Number} index - The index.
* @return {WebExtension} The web extension.
*/
get(index) {
}
/**
* Adds a web extension.
* @return {Number} The index.
*/
add() {
}
/**
* Add a web video player into exel.
* @param {String} url
* @param {boolean} autoPlay - Indicates whether auto playing the video.
* @param {Number} startTime - The start time in unit of seconds.
* @param {Number} endTime - The end time in unit of seconds.
*/
addWebVideoPlayer(url, autoPlay, startTime, endTime) {
}
/**
* Remove web extension by the index.
* @param {Number} index - The index.
*/
removeAt(index) {
}
/**
*/
clear() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents an Office Add-in custom property.
* @hideconstructor
*/
class WebExtensionProperty {
/**
* Gets and set a custom property name.
*/
getName() {
}
/**
* Gets and set a custom property name.
*/
setName(value) {
}
/**
* Gets and sets a custom property value.
*/
getValue() {
}
/**
* Gets and sets a custom property value.
*/
setValue(value) {
}
}
/**
* Represents the list of web extension properties.
*/
class WebExtensionPropertyCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets the property of web extension by the index.
* @param {Number} index - The index.
* @return {WebExtensionProperty} The property of web extension.
*/
get(index) {
}
/**
* Gets the property of web extension.
* @param {String} name - The name of property.
* @return {WebExtensionProperty} The property of web extension.
*/
get(name) {
}
/**
* Adds web extension property.
* @param {String} name - The name of property.
* @param {String} value - The value of property.
* @return {Number} The index of added property.
*/
add(name, value) {
}
/**
* Remove the property by the name.
* @param {String} name - The name of the property.
*/
removeAt(name) {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents identify the provider location and version of the extension.
* @hideconstructor
*/
class WebExtensionReference {
/**
* 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() {
}
/**
* Gets and sets the identifier associated with the Office Add-in within a catalog provider.
* The identifier MUST be unique within a catalog provider.
*/
setId(value) {
}
/**
* Gets and sets the version.
*/
getVersion() {
}
/**
* Gets and sets the version.
*/
setVersion(value) {
}
/**
* Gets and sets the instance of the marketplace where the Office Add-in is stored. .
*/
getStoreName() {
}
/**
* Gets and sets the instance of the marketplace where the Office Add-in is stored. .
*/
setStoreName(value) {
}
/**
* Gets and sets the type of marketplace that the store attribute identifies.
* The value of the property is WebExtensionStoreType integer constant.
*/
getStoreType() {
}
/**
* Gets and sets the type of marketplace that the store attribute identifies.
* The value of the property is WebExtensionStoreType integer constant.
*/
setStoreType(value) {
}
}
/**
* Represents the list of web extension reference.
*/
class WebExtensionReferenceCollection {
/**
*/
constructor() {
}
/**
*/
getCount() {
}
/**
* Gets web extension by the specific index.
* @param {Number} index - The index.
* @return {WebExtensionReference} The web extension
*/
get(index) {
}
/**
* Adds an empty reference of web extension.
* @return {Number}
*/
add() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the shape of web extension.
* @hideconstructor
*/
class WebExtensionShape {
/**
* Gets and set the web extension.
*/
getWebExtension() {
}
/**
* Gets and set the web extension.
*/
setWebExtension(value) {
}
/**
* Gets and sets the name of macro.
*/
getMacroName() {
}
/**
* Gets and sets the name of macro.
*/
setMacroName(value) {
}
/**
* Indicates whether the shape only contains an equation.
*/
isEquation() {
}
/**
* Indicates whether the shape is smart art.
* Only for ooxml file.
*/
isSmartArt() {
}
/**
* Returns the position of a shape in the z-order.
*/
getZOrderPosition() {
}
/**
* Returns the position of a shape in the z-order.
*/
setZOrderPosition(value) {
}
/**
* Gets and sets the name of the shape.
*/
getName() {
}
/**
* Gets and sets the name of the shape.
*/
setName(value) {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
getAlternativeText() {
}
/**
* Returns or sets the descriptive (alternative) text string of the Shape object.
*/
setAlternativeText(value) {
}
/**
* Specifies the title (caption) of the current shape object.
*/
getTitle() {
}
/**
* Specifies the title (caption) of the current shape object.
*/
setTitle(value) {
}
/**
* Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Line property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLineFormat() {
}
/**
* Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.Fill property.
* This property will be removed 12 months later since July 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getFillFormat() {
}
/**
* Gets line style
*/
getLine() {
}
/**
* Returns a FillFormat object that contains fill formatting properties for the specified shape.
*/
getFill() {
}
/**
* Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
*/
getShadowEffect() {
}
/**
* Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
*/
getReflection() {
}
/**
* Represents a GlowEffect object that specifies glow effect for the chart element or shape.
*/
getGlow() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
getSoftEdges() {
}
/**
* Gets and sets the radius of blur to apply to the edges, in unit of points.
*/
setSoftEdges(value) {
}
/**
* Gets and sets 3d format of the shape.
*/
getThreeDFormat() {
}
/**
* Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
* NOTE: This member is now obsolete. Instead,
* please use Shape.TextBody.TextAlignment property.
* This property will be removed 12 months later since May 2016.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTextFrame() {
}
/**
* Gets and sets the options of the picture format.
*/
getFormatPicture() {
}
/**
* Indicates whether the object is visible.
*/
isHidden() {
}
/**
* Indicates whether the object is visible.
*/
setHidden(value) {
}
/**
* True means that don't allow changes in aspect ratio.
*/
isLockAspectRatio() {
}
/**
* True means that don't allow changes in aspect ratio.
*/
setLockAspectRatio(value) {
}
/**
* Gets and sets the rotation of the shape.
*/
getRotationAngle() {
}
/**
* Gets and sets the rotation of the shape.
*/
setRotationAngle(value) {
}
/**
* Gets the hyperlink of the shape.
*/
getHyperlink() {
}
/**
* Gets the identifier of this shape.
*/
getId() {
}
/**
* Specifies an optional string that an application can use to Identify the particular shape.
*/
getSpid() {
}
/**
* Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
*/
getSpt() {
}
/**
* Gets the Worksheet object which contains this shape.
*/
getWorksheet() {
}
/**
* Indicates whether the shape is a group.
*/
isGroup() {
}
/**
* Indicates whether the shape is grouped.
*/
isInGroup() {
}
/**
* Indicates whether this shape is a word art.
* Only for the Legacy Shape of xls file.
*/
isWordArt() {
}
/**
* Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
* Applies to Shape objects that represent WordArt.
*/
getTextEffect() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
isLocked() {
}
/**
* True if the object is locked, False if the object can be modified when the sheet is protected.
*/
setLocked(value) {
}
/**
* True if the object is printable
*/
isPrintable() {
}
/**
* True if the object is printable
*/
setPrintable(value) {
}
/**
* Gets mso drawing type.
* The value of the property is MsoDrawingType integer constant.
*/
getMsoDrawingType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getAutoShapeType() {
}
/**
* Gets and sets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
setAutoShapeType(value) {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
getAnchorType() {
}
/**
* Gets and set the shape anchor placeholder.
* The value of the property is ShapeAnchorType integer constant.
*/
setAnchorType(value) {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
getPlacement() {
}
/**
* Represents the way the drawing object is attached to the cells below it.
* The property controls the placement of an object on a worksheet.
* The value of the property is PlacementType integer constant.
*/
setPlacement(value) {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
getUpperLeftRow() {
}
/**
* Represents upper left corner row index.
* If the shape is in the shape or in the group , UpperLeftRow will be ignored.
*/
setUpperLeftRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
getUpperDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its upper left corner row.
* The range of value is 0 to 256.
*/
setUpperDeltaY(value) {
}
/**
* Represents upper left corner column index.
*/
getUpperLeftColumn() {
}
/**
* Represents upper left corner column index.
*/
setUpperLeftColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
getUpperDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its upper left corner column.
* The range of value is 0 to 1024.
*/
setUpperDeltaX(value) {
}
/**
* Represents lower right corner row index.
*/
getLowerRightRow() {
}
/**
* Represents lower right corner row index.
*/
setLowerRightRow(value) {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
getLowerDeltaY() {
}
/**
* Gets or sets the shape's vertical offset from its lower right corner row.
* The range of value is 0 to 256.
*/
setLowerDeltaY(value) {
}
/**
* Represents lower right corner column index.
*/
getLowerRightColumn() {
}
/**
* Represents lower right corner column index.
*/
setLowerRightColumn(value) {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
getLowerDeltaX() {
}
/**
* Gets or sets the shape's horizontal offset from its lower right corner column.
* The range of value is 0 to 1024.
*/
setLowerDeltaX(value) {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
getRight() {
}
/**
* Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
*/
setRight(value) {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
getBottom() {
}
/**
* Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
*/
setBottom(value) {
}
/**
* Represents the width of shape, in unit of pixels.
*/
getWidth() {
}
/**
* Represents the width of shape, in unit of pixels.
*/
setWidth(value) {
}
/**
* Represents the width of the shape, in unit of inch.
*/
getWidthInch() {
}
/**
* Represents the width of the shape, in unit of inch.
*/
setWidthInch(value) {
}
/**
* Represents the width of the shape, in unit of point.
*/
getWidthPt() {
}
/**
* Represents the width of the shape, in unit of point.
*/
setWidthPt(value) {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
getWidthCM() {
}
/**
* Represents the width of the shape, in unit of centimeters.
*/
setWidthCM(value) {
}
/**
* Represents the height of shape, in unit of pixel.
*/
getHeight() {
}
/**
* Represents the height of shape, in unit of pixel.
*/
setHeight(value) {
}
/**
* Represents the height of the shape, in unit of inches.
*/
getHeightInch() {
}
/**
* Represents the height of the shape, in unit of inches.
*/
setHeightInch(value) {
}
/**
* Represents the height of the shape, in unit of points.
*/
getHeightPt() {
}
/**
* Represents the height of the shape, in unit of points.
*/
setHeightPt(value) {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
getHeightCM() {
}
/**
* Represents the height of the shape, in unit of centimeters.
*/
setHeightCM(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
getLeft() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of pixels.
*/
setLeft(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
getLeftInch() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of inches.
*/
setLeftInch(value) {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
getLeftCM() {
}
/**
* Represents the horizontal offset of shape from its left column, in unit of centimeters.
*/
setLeftCM(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
getTop() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of pixels.
* If the shape is in the chart, represents the vertical offset of shape from its top border.
*/
setTop(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
getTopInch() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of inches.
*/
setTopInch(value) {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
getTopCM() {
}
/**
* Represents the vertical offset of shape from its top row, in unit of centimeters.
*/
setTopCM(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
getTopToCorner() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
*/
setTopToCorner(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
getLeftToCorner() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border.
*/
setLeftToCorner(value) {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
getX() {
}
/**
* Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
*/
setX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
getY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
*/
setY(value) {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
getWidthScale() {
}
/**
* Gets and sets the width scale, in unit of percent of the original picture width.
* If the shape is not picture ,the WidthScale property only returns 100;
*/
setWidthScale(value) {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
getHeightScale() {
}
/**
* Gets and sets the height scale,in unit of percent of the original picture height.
* If the shape is not picture ,the HeightScale property only returns 100;
*/
setHeightScale(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getTopInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape,
* in unit of 1/4000 of height of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setTopInShape(value) {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getLeftInShape() {
}
/**
* Represents the horizontal offset of shape from the left border of the parent shape,
* in unit of 1/4000 of width of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setLeftInShape(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
getWidthInShape() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* Only Applies when this shape in the group or chart.
*/
setWidthInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
getHeightInShape() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* Only Applies when this shape in the group or chart.
*/
setHeightInShape(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getHeightInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.HeightInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setHeightInChart(value) {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getLeftInChart() {
}
/**
* Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.LeftInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setLeftInChart(value) {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getTopInChart() {
}
/**
* Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.TopInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTopInChart(value) {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getWidthInChart() {
}
/**
* Represents the width of the shape, in unit of 1/4000 of the parent shape.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.WidthInShape property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setWidthInChart(value) {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionX() {
}
/**
* Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.X property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionX(value) {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getPositionY() {
}
/**
* Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Drawing.Shape.Y property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setPositionY(value) {
}
/**
* Gets the group shape which contains this shape.
*/
getGroup() {
}
/**
* Gets the auto shape type.
* The value of the property is AutoShapeType integer constant.
*/
getType() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
hasLine() {
}
/**
* Gets and sets the line border of the shape is visible.
*/
setHasLine(value) {
}
/**
* Indicates whether the fill format is visible.
*/
isFilled() {
}
/**
* Indicates whether the fill format is visible.
*/
setFilled(value) {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
isFlippedHorizontally() {
}
/**
* Gets and sets whether shape is horizontally flipped .
*/
setFlippedHorizontally(value) {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
isFlippedVertically() {
}
/**
* Gets and sets whether shape is vertically flipped .
*/
setFlippedVertically(value) {
}
/**
* Get the actual bottom row.
*/
getActualLowerRightRow() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
getRelativeToOriginalPictureSize() {
}
/**
* Indicates whether shape is relative to original picture size.
*/
setRelativeToOriginalPictureSize(value) {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
getLinkedCell() {
}
/**
* Gets or sets the worksheet range linked to the control's value.
*/
setLinkedCell(value) {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
getInputRange() {
}
/**
* Gets or sets the worksheet range used to fill the specified combo box.
*/
setInputRange(value) {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
getTextShapeType() {
}
/**
* Gets and sets the preset text shape type.
* The value of the property is AutoShapeType integer constant.
*/
setTextShapeType(value) {
}
/**
* Gets and sets the setting of the shape's text.
*/
getTextBody() {
}
/**
* Represents the font of shape.
*/
getFont() {
}
/**
* Represents the font of shape.
*/
setFont(value) {
}
/**
* Represents the text options of the shape.
*/
getTextOptions() {
}
/**
* Represents the text options of the shape.
*/
setTextOptions(value) {
}
/**
* Represents the string in this TextBox object.
*/
getText() {
}
/**
* Represents the string in this TextBox object.
*/
setText(value) {
}
/**
* Whether or not the text is rich text.
*/
isRichText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
getHtmlText() {
}
/**
* Gets and sets the html string which contains data and some formats in this textbox.
*/
setHtmlText(value) {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextVerticalOverflow() {
}
/**
* Gets and sets the text vertical overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextVerticalOverflow(value) {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
getTextHorizontalOverflow() {
}
/**
* Gets and sets the text horizontal overflow type of the shape which contains text.
* The value of the property is TextOverflowType integer constant.
*/
setTextHorizontalOverflow(value) {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
isTextWrapped() {
}
/**
* Gets and sets the text wrapped type of the shape which contains text.
*/
setTextWrapped(value) {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
getTextOrientationType() {
}
/**
* Gets and sets the text orientation type of the shape.
* The value of the property is TextOrientationType integer constant.
*/
setTextOrientationType(value) {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextHorizontalAlignment() {
}
/**
* Gets and sets the text horizontal alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextHorizontalAlignment(value) {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
getTextVerticalAlignment() {
}
/**
* Gets and sets the text vertical alignment type of the shape.
* The value of the property is TextAlignmentType integer constant.
*/
setTextVerticalAlignment(value) {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
getTextDirection() {
}
/**
* Gets/Sets the direction of the text flow for this object.
* The value of the property is TextDirectionType integer constant.
*/
setTextDirection(value) {
}
/**
* Gets the data of control.
*/
getControlData() {
}
/**
* Gets the ActiveX control.
*/
getActiveXControl() {
}
/**
* Gets the paths of a custom geometric shape.
*/
getPaths() {
}
/**
* Gets the geometry
*/
getGeometry() {
}
/**
* Gets and sets create id for this shape.
*/
getCreateId() {
}
/**
* Gets and sets create id for this shape.
*/
setCreateId(value) {
}
/**
* Gets the range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range linked to the control's value.
*/
getLinkedCell(isR1C1, isLocal) {
}
/**
* Sets the range linked to the control's value.
* @param {String} formula - The range linked to the control's value.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setLinkedCell(formula, isR1C1, isLocal) {
}
/**
* Gets the range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
* @return {String} The range used to fill the control.
*/
getInputRange(isR1C1, isLocal) {
}
/**
* Sets the range used to fill the control.
* @param {String} formula - The range used to fill the control.
* @param {boolean} isR1C1 - Whether the formula needs to be formatted as R1C1.
* @param {boolean} isLocal - Whether the formula needs to be formatted by locale.
*/
setInputRange(formula, isR1C1, isLocal) {
}
/**
* Update the selected value by the value of the linked cell.
*/
updateSelectedValue() {
}
/**
* Recalculate the text area
* @return {Number[]} Text's Size in an array(width and height).
*/
calculateTextSize() {
}
/**
* Formats some characters with the font setting.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
* @param {StyleFlag} flag - The flag of the font setting.
*/
formatCharacters(startIndex, length, font, flag) {
}
/**
* Formats some characters with the font setting.
* NOTE: This member is now obsolete. Instead,
* please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method.
* This property will be removed 12 months later since March 2016.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} startIndex - The start index.
* @param {Number} length - The length.
* @param {Font} font - The font setting.
*/
formatCharacters(startIndex, length, font) {
}
/**
* Returns a Characters object that represents a range of characters within the text.
* This method only works on shape with title.
* @param {Number} startIndex - The index of the start of the character.
* @param {Number} length - The number of characters.
* @return {FontSetting} Characters object.
*/
characters(startIndex, length) {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* NOTE: This method is now obsolete. Instead,
* please use Shape.GetRichFormattings() method.
* This method will be removed 12 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* Returns all Characters objects
* that represents a range of characters within the text .
* @return {FontSetting[]} All Characters objects
*/
getRichFormattings() {
}
/**
* Remove activeX control.
*/
removeActiveXControl() {
}
/**
* Returns whether the shape is same.
* @param {Object} obj
* @return {boolean}
*/
isSameSetting(obj) {
}
/**
* Get the actual position and size of the shape (after applying rotation, flip, etc.)
* Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.@return {float[]} Return the position and size in the order of x, y, w, h
*/
getActualBox() {
}
/**
* Get the connection points
* @return {float[][]} [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
*/
getConnectionPoints() {
}
/**
* Creates the shape image and saves it to a stream in the specified format.
* The following formats are supported:
* .bmp, .gif, .jpg, .jpeg, .tiff, .emf.
* @param {OutputStream} stream - The output stream.
* @param {ImageFormat} imageFormat - The format in which to save the image.
*/
toImage(stream, imageFormat) {
}
/**
* Saves the shape to a file.
*/
toImage(imageFile, options) {
}
/**
* Saves the shape to a stream.
*/
toImage(stream, options) {
}
/**
* Converting smart art to grouped shapes.
*/
getResultOfSmartArt() {
}
/**
* Brings the shape to the front or sends the shape to back.
* @param {Number} orders -
* If it's less than zero, sets the shape to back.
* If it's greater than zero, brings the shape to front.
*/
toFrontOrBack(orders) {
}
/**
* Gets the value of locked property.
* @param {Number} type - ShapeLockType
* @return {boolean} Returns the value of locked property.
*/
getLockedProperty(type) {
}
/**
* Set the locked property.
* @param {Number} type - ShapeLockType
* @param {boolean} value - The value of the property.
*/
setLockedProperty(type, value) {
}
/**
* Adds a hyperlink to the shape.
* @param {String} address - Address of the hyperlink.
* @return {Hyperlink} Return the new hyperlink object.
*/
addHyperlink(address) {
}
/**
* Remove the hyperlink of the shape.
*/
removeHyperlink() {
}
/**
* Moves the shape to a specified range.
* @param {Number} upperLeftRow - Upper left row index.
* @param {Number} upperLeftColumn - Upper left column index.
* @param {Number} lowerRightRow - Lower right row index
* @param {Number} lowerRightColumn - Lower right column index
*/
moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) {
}
/**
* Moves the picture to the top-right corner.
* @param {Number} topRow - the row index.
* @param {Number} rightColumn - the column index.
*/
alignTopRightCorner(topRow, rightColumn) {
}
}
/**
* Represents a persisted taskpane object.
* @hideconstructor
*/
class WebExtensionTaskPane {
/**
* Gets and sets the web extension part associated with the taskpane instance
*/
getWebExtension() {
}
/**
* Gets and sets the web extension part associated with the taskpane instance
*/
setWebExtension(value) {
}
/**
* Gets and sets the last-docked location of this taskpane object.
*/
getDockState() {
}
/**
* Gets and sets the last-docked location of this taskpane object.
*/
setDockState(value) {
}
/**
* Indicates whether the Task Pane shows as visible by default when the document opens.
*/
isVisible() {
}
/**
* Indicates whether the Task Pane shows as visible by default when the document opens.
*/
setVisible(value) {
}
/**
* Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.
*/
isLocked() {
}
/**
* Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.
*/
setLocked(value) {
}
/**
* Gets and sets the default width value for this taskpane instance.
*/
getWidth() {
}
/**
* Gets and sets the default width value for this taskpane instance.
*/
setWidth(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setRow(value) {
}
}
/**
* Represents the list of task pane.
* @hideconstructor
*/
class WebExtensionTaskPaneCollection {
/**
*/
getCount() {
}
/**
* Gets task pane by the specific index.
* @param {Number} index - The index.
* @return {WebExtensionTaskPane} The task pane.
*/
get(index) {
}
/**
* Adds task pane.
* @return {Number} The index.
*/
add() {
}
/**
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* 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.
* @hideconstructor
*/
class WebQueryConnection {
/**
* true if the web query source is XML (versus HTML), otherwise false.
*/
isXml() {
}
/**
* true if the web query source is XML (versus HTML), otherwise false.
*/
setXml(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setXl97(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setXl2000(value) {
}
/**
* URL to use to refresh external data.
*/
getUrl() {
}
/**
* URL to use to refresh external data.
*/
setUrl(value) {
}
/**
* Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.
*/
isTextDates() {
}
/**
* Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates.
*/
setTextDates(value) {
}
/**
* Flag indicating that XML source data should be imported instead of the HTML table itself.
*/
isXmlSourceData() {
}
/**
* Flag indicating that XML source data should be imported instead of the HTML table itself.
*/
setXmlSourceData(value) {
}
/**
* 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() {
}
/**
* Returns or sets the string used with the post method of inputting data into a web server
* to return data from a web query.
*/
setPost(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setParsePre(value) {
}
/**
* Flag indicating whether web queries should only work on HTML tables.
*/
isHtmlTables() {
}
/**
* Flag indicating whether web queries should only work on HTML tables.
*/
setHtmlTables(value) {
}
/**
* How to handle formatting from the HTML source when bringing web query data into the
* worksheet. Relevant when sourceData is True.
* The value of the property is HtmlFormatHandlingType integer constant.
*/
getHtmlFormat() {
}
/**
* How to handle formatting from the HTML source when bringing web query data into the
* worksheet. Relevant when sourceData is True.
* The value of the property is HtmlFormatHandlingType integer constant.
*/
setHtmlFormat(value) {
}
/**
* Flag indicating whether to parse all tables inside a PRE block with the same width settings
* as the first row.
*/
isSameSettings() {
}
/**
* Flag indicating whether to parse all tables inside a PRE block with the same width settings
* as the first row.
*/
setSameSettings(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setEditWebPage(value) {
}
/**
* 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.
* NOTE: This property is now obsolete. Instead,
* please use WebQueryConnection.EditWebPage property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getEditPage() {
}
/**
* 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.
* NOTE: This property is now obsolete. Instead,
* please use WebQueryConnection.EditWebPage property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setEditPage(value) {
}
/**
* Flag indicating whether consecutive delimiters should be treated as just one delimiter.
*/
isConsecutive() {
}
/**
* Flag indicating whether consecutive delimiters should be treated as just one delimiter.
*/
setConsecutive(value) {
}
/**
* Gets the id of the connection.
*/
getId() {
}
/**
* Gets the definition of power query formula.
*/
getPowerQueryFormula() {
}
/**
* Gets or Sets the external connection DataSource type.
*/
getType() {
}
/**
* 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() {
}
/**
* 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.
*/
setSourceFile(value) {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
getSSOId() {
}
/**
* Identifier for Single Sign On (SSO) used for authentication between an intermediate
* spreadsheetML server and the external data source.
*/
setSSOId(value) {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
getSavePassword() {
}
/**
* True if the password is to be saved as part of the connection string; otherwise, False.
*/
setSavePassword(value) {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
getSaveData() {
}
/**
* True if the external data fetched over the connection to populate a table is to be saved
* with the workbook; otherwise, false.
*/
setSaveData(value) {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
getRefreshOnLoad() {
}
/**
* True if this connection should be refreshed when opening the file; otherwise, false.
*/
setRefreshOnLoad(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
getReconnectionMethodType() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
*/
setReconnectionMethodType(value) {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getReconnectionMethod() {
}
/**
* Specifies what the spreadsheet application should do when a connection fails.
* The default value is ReConnectionMethodType.Required.
* The value of the property is ReConnectionMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.ReconnectionMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setReconnectionMethod(value) {
}
/**
* 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() {
}
/**
* 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
*/
setOnlyUseConnectionFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOdcFile(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setNew(value) {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
getName() {
}
/**
* Specifies the name of the connection. Each connection must have a unique name.
*/
setName(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setKeepAlive(value) {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
getRefreshInternal() {
}
/**
* Specifies the number of minutes between automatic refreshes of the connection.
*/
setRefreshInternal(value) {
}
/**
* Specifies The unique identifier of this connection.
*/
getConnectionId() {
}
/**
* Specifies the user description for this connection
*/
getConnectionDescription() {
}
/**
* Specifies the user description for this connection
*/
setConnectionDescription(value) {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
isDeleted() {
}
/**
* Indicates whether the associated workbook connection has been deleted. true if the
* connection has been deleted; otherwise, false.
*/
setDeleted(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
getCredentialsMethodType() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
*/
setCredentialsMethodType(value) {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getCredentials() {
}
/**
* Specifies the authentication method to be used when establishing (or re-establishing) the connection.
* The value of the property is CredentialsMethodType integer constant.
* NOTE: This property is now obsolete. Instead,
* please use ExternalConnection.CredentialsMethodType property.
* This property will be removed 12 months later since October 2017.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCredentials(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setBackgroundRefresh(value) {
}
/**
* Gets ConnectionParameterCollection for an ODBC or web query.
*/
getParameters() {
}
}
/**
* Represents a root object to create an Excel spreadsheet.
* 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.
* @exampleThe following example creates a Workbook, opens a file named designer.xls in it and makes the horizontal and vertical scroll bars invisible for the Workbook. It then replaces two string values with an Integer value and string value respectively within the spreadsheet and finally save it to file named result.xls.
* //Use Aspose.Cells for Node.js via Java
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* //Open a designer file
* var designerFile = "designer.xls";
* var workbook = new aspose.cells.Workbook(designerFile);
* //Set scroll bars
* workbook.getSettings().setHScrollBarVisible(false);
* workbook.getSettings().setVScrollBarVisible(false);
* //Replace the placeholder string with new values
* workbook.replace("OldInt", 100);
* var newString = "Hello!";
* workbook.replace("OldString", newString);
* var saveOptions = new aspose.cells.XlsSaveOptions();
* workbook.save("result.xls", saveOptions);
*/
class Workbook {
/**
* Initializes a new instance of the Workbook class.
* The default file format type is Xlsx. If you want to create other types of files, please use Workbook(FileFormatType).
* @exampleThe following code shows how to use the Workbook constructor to create and initialize a new instance of the class.
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var workbook = new aspose.cells.Workbook();
*/
constructor() {
}
/**
* Initializes a new instance of the Workbook class.
* The default file format type is Excel97To2003.
* @param {Number} fileFormatType - FileFormatType
* @exampleThe following code shows how to use the Workbook constructor to create and initialize a new instance of the class.
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var workbook = new aspose.cells.Workbook(aspose.cells.FileFormatType.XLSX);
*/
constructor_overload$1(fileFormatType) {
}
/**
* Initializes a new instance of the Workbook class and open a file.
* @param {String} file - The file name.
*/
constructor_overload$2(file) {
}
/**
* Initializes a new instance of the Workbook class and open a file.
* @param {String} file - The file name.
* @param {LoadOptions} loadOptions - The load options
*/
constructor_overload$3(file, loadOptions) {
}
/**
* Represents the workbook settings.
*/
getSettings() {
}
/**
* Gets the WorksheetCollection collection in the spreadsheet.
* @return {WorksheetCollection} WorksheetCollection collection
*/
getWorksheets() {
}
/**
* Indicates whether license is set.
*/
isLicensed() {
}
/**
* Returns colors in the palette for the spreadsheet.
* The palette has 56 entries, each represented by an RGB value.
*/
getColors() {
}
/**
* Gets number of the styles in the style pool.
*/
getCountOfStylesInPool() {
}
/**
* Gets or sets the default Style object of the workbook.
* The DefaultStyle property is useful to implement a Style for the whole Workbook.
* @exampleThe following code creates and instantiates a new Workbook and sets a default Style to it.
* var workbook = new aspose.cells.Workbook();
* var defaultStyle = workbook.getDefaultStyle();
* defaultStyle.getFont().setName("Tahoma");
* workbook.setDefaultStyle(defaultStyle);
*/
getDefaultStyle() {
}
/**
* Gets or sets the default Style object of the workbook.
* The DefaultStyle property is useful to implement a Style for the whole Workbook.
* @exampleThe following code creates and instantiates a new Workbook and sets a default Style to it.
* var workbook = new aspose.cells.Workbook();
* var defaultStyle = workbook.getDefaultStyle();
* defaultStyle.getFont().setName("Tahoma");
* workbook.setDefaultStyle(defaultStyle);
*/
setDefaultStyle(value) {
}
/**
* Indicates if this spreadsheet is digitally signed.
*/
isDigitallySigned() {
}
/**
* Indicates whether structure or window is protected with password.
*/
isWorkbookProtectedWithPassword() {
}
/**
* Gets the VbaProject in a spreadsheet.
*/
getVbaProject() {
}
/**
* Indicates if this spreadsheet contains macro/VBA.
*/
hasMacro() {
}
/**
* Gets if the workbook has any tracked changes
*/
hasRevisions() {
}
/**
* Gets and sets the current file name.
* If the file is opened by stream and there are some external formula references,
* please set the file name.
*/
getFileName() {
}
/**
* Gets and sets the current file name.
* If the file is opened by stream and there are some external formula references,
* please set the file name.
*/
setFileName(value) {
}
/**
* Gets the factory for building ICellsDataTable from custom objects
*/
getCellsDataTableFactory() {
}
/**
* Gets a DataSorter object to sort data.
*/
getDataSorter() {
}
/**
* Gets the theme name.
*/
getTheme() {
}
/**
* Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
* 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:
* TitleSubjectAuthorKeywordsCommentsTemplateLast AuthorRevision NumberApplication NameLast Print DateCreation DateLast Save TimeTotal Editing TimeNumber of PagesNumber of WordsNumber of CharactersSecurityCategoryFormatManagerCompanyNumber of BytesNumber of LinesNumber of ParagraphsNumber of SlidesNumber of NotesNumber of Hidden SlidesNumber of Multimedia Clips
* @example
* var doc = workbook.getBuiltInDocumentProperties().get("Author");
* doc.setValue("John Smith");
*/
getBuiltInDocumentProperties() {
}
/**
* Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.
* @example
* var excel = new aspose.cells.Workbook();
* excel.getCustomDocumentProperties().add("Checked by", "Jane");
*/
getCustomDocumentProperties() {
}
/**
* Gets and sets the file format.
* The value of the property is FileFormatType integer constant.
*/
getFileFormat() {
}
/**
* Gets and sets the file format.
* The value of the property is FileFormatType integer constant.
*/
setFileFormat(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Gets the list of ContentTypeProperty objects in the workbook.
*/
getContentTypeProperties() {
}
/**
* Represents a Custom XML Data Storage Part (custom XML data within a package).
*/
getCustomXmlParts() {
}
/**
* Gets mashup data.
*/
getDataMashup() {
}
/**
* Gets and sets the XML file that defines the Ribbon UI.
*/
getRibbonXml() {
}
/**
* Gets and sets the XML file that defines the Ribbon UI.
*/
setRibbonXml(value) {
}
/**
* Gets and sets the absolute path of the file.
* Only used for external links.
*/
getAbsolutePath() {
}
/**
* Gets and sets the absolute path of the file.
* Only used for external links.
*/
setAbsolutePath(value) {
}
/**
* Gets the ExternalConnection collection.
*/
getDataConnections() {
}
/**
* Parses all formulas which have not been parsed when they were loaded from template file or set to a cell.
* @param {boolean} 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) {
}
/**
* Starts the session that uses caches to access data.
* 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, closeAccessCache(int) should
* be invoked with same options to clear all caches and recover normal access mode.
* @param {Number} opts - AccessCacheOptions
*/
startAccessCache(opts) {
}
/**
* Closes the session that uses caches to access data.
* @param {Number} opts - AccessCacheOptions
*/
closeAccessCache(opts) {
}
/**
* Saves the workbook to the disk.
* @param {String} fileName - The file name.
* @param {Number} saveFormat - SaveFormat
* @example
* var workbook = new aspose.cells.Workbook();
* var sheets = workbook.getWorksheets();
* var cells = sheets.get(0).getCells();
* cells.get("A1").putValue("Hello world!");
* workbook.save("Book1.xls", aspose.cells.SaveFormat.EXCEL_97_TO_2003);
*/
save(fileName, saveFormat) {
}
/**
* Save the workbook to the disk.
* @param {String} fileName
*/
save(fileName) {
}
/**
* Saves the workbook to the disk.
* @param {String} fileName - The file name.
* @param {SaveOptions} saveOptions - The save options.
*/
save(fileName, saveOptions) {
}
/**
* Remove all unused styles.
*/
removeUnusedStyles() {
}
/**
* Creates a new style.
* @return {Style} Returns a style object.
*/
createStyle() {
}
/**
* Creates built-in style by given type.
* @param {Number} type - BuiltinStyleType
* @return {Style} Style object
*/
createBuiltinStyle(type) {
}
/**
* Creates a CellsColor object.
* @return {CellsColor} Returns a CellsColor object.
*/
createCellsColor() {
}
/**
* Replaces a cell's value with a new string.
* @param {String} placeHolder - Cell placeholder
* @param {String} newValue - String value to replace
* @example
* var workbook = new aspose.cells.Workbook();
* workbook.replace("AnOldValue", "NewValue");
*/
replace(placeHolder, newValue) {
}
/**
* Replaces a cell's value with a new integer.
* @param {String} placeHolder - Cell placeholder
* @param {Number} newValue - Integer value to replace
* @example
* var workbook = new aspose.cells.Workbook();
* var newValue = 100;
* workbook.replace("AnOldValue", newValue);
*/
replace(placeHolder, newValue) {
}
/**
* Replaces a cell's value with a new double.
* @param {String} placeHolder - Cell placeholder
* @param {Number} newValue - Double value to replace
* @example
* var workbook = new aspose.cells.Workbook();
* var newValue = 100.0;
* workbook.replace("AnOldValue", newValue);
*/
replace(placeHolder, newValue) {
}
/**
* Replaces a cell's value with a new string array.
* @param {String} placeHolder - Cell placeholder
* @param {String[]} newValues - String array to replace
* @param {boolean} isVertical - True - Vertical, False - Horizontal
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var java = require("java");
* var workbook = new aspose.cells.Workbook();
* var newValues = java.newArray("java.lang.String", ["Tom", "Alice", "Jerry"]);
* workbook.replace("AnOldValue", newValues, true);
*/
replace(placeHolder, newValues, isVertical) {
}
/**
* Replaces a cell's value with a new string.
* @param {String} placeHolder - Cell placeholder
* @param {String} newValue - String value to replace
* @param {ReplaceOptions} options - The replace options
*/
replace(placeHolder, newValue, options) {
}
/**
* Copies another Workbook object.
* It's very simple to clone an Excel file.
* @param {Workbook} source - Source Workbook object.
* @param {CopyOptions} copyOptions - The options of copying other workbook.
*/
copy(source, copyOptions) {
}
/**
* Copies data from a source Workbook object.
* @param {Workbook} source - Source Workbook object.
*/
copy(source) {
}
/**
* Combines another Workbook object.
* Merge Excel, ODS , CSV and other files to one file.
* @param {Workbook} secondWorkbook - Another Workbook object.
*/
combine(secondWorkbook) {
}
/**
* 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.
* If the returned style is changed, the style of all cells(which refers to this style) will be changed.
* @param {Number} index - The index.
* @return {Style}
* The style in the pool corresponds to given index, may be null.
*/
getStyleInPool(index) {
}
/**
* Gets all fonts in the style pool.
*/
getFonts() {
}
/**
* Gets the named style in the style pool.
* @param {String} name - name of the style
* @return {Style} named style, maybe null.
*/
getNamedStyle(name) {
}
/**
* Changes the palette for the spreadsheet in the specified index.
* 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.ColorRedGreenBlueBlack000White255255255Red25500Lime02550Blue00255Yellow2552550Magenta2550255Cyan0255255Maroon12800Green01280Navy00128Olive1281280Purple1280128Teal0128128Silver192192192Gray128128128Color17153153255Color1815351102Color19255255204Color20204255255Color211020102Color22255128128Color230102204Color24204204255Color2500128Color262550255Color272552550Color280255255Color291280128Color3012800Color310128128Color3200255Color330204255Color34204255255Color35204255204Color36255255153Color37153204255Color38255153204Color39204153255Color40255204153Color4151102255Color4251204204Color431532040Color442552040Color452551530Color462551020Color47102102153Color48150150150Color49051102Color5051153102Color510510Color5251510Color53153510Color5415351102Color555151153Color56515151
* @param {Color} color - Color structure.
* @param {Number} index - Palette index, 0 - 55.
*/
changePalette(color, index) {
}
/**
* Checks if a color is in the palette for the spreadsheet.
* @param {Color} color - Color structure.
* @return {boolean} Returns true if this color is in the palette. Otherwise, returns false
*/
isColorInPalette(color) {
}
/**
* Calculates the result of formulas.
* For all supported formulas, please see the list at https://docs.aspose.com/display/cellsnet/Supported+Formula+Functions
*/
calculateFormula() {
}
/**
* Calculates the result of formulas.
* @param {boolean} ignoreError - Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc.
*/
calculateFormula(ignoreError) {
}
/**
* Calculating formulas in this workbook.
* @param {CalculationOptions} options - Options for calculation
*/
calculateFormula(options) {
}
/**
* 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 {boolean} calculate - Whether calculates and updates cell values for those dynamic array formulas
*/
refreshDynamicArrayFormulas(calculate) {
}
/**
* Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data)
* 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 calculateFormula(com.aspose.cells.CalculationOptions)),
* then using false vlaue for "calculate" flag may avoid the duplicated calculation for the benefit of performance.
* @param {boolean} calculate - Whether calculates and updates cell values for those dynamic array formulas
* @param {CalculationOptions} copts - The options for calculating formulas
*/
refreshDynamicArrayFormulas(calculate, copts) {
}
/**
* Find best matching Color in current palette.
* @param {Color} rawColor - Raw color.
* @return {Color} Best matching color.
*/
getMatchingColor(rawColor) {
}
/**
* Set Encryption Options.
* @param {Number} encryptionType - EncryptionType
* @param {Number} keyLength - The key length.
*/
setEncryptionOptions(encryptionType, keyLength) {
}
/**
* Protects a workbook.
* @param {Number} protectionType - ProtectionType
* @param {String} password - Password to protect the workbook.
*/
protect(protectionType, password) {
}
/**
* Protects a shared workbook.
* @param {String} password - Password to protect the workbook.
*/
protectSharedWorkbook(password) {
}
/**
* Unprotects a workbook.
* @param {String} password - Password to unprotect the workbook.
*/
unprotect(password) {
}
/**
* Unprotects a shared workbook.
* @param {String} password - Password to unprotect the workbook.
*/
unprotectSharedWorkbook(password) {
}
/**
* Removes VBA/macro from this spreadsheet.
*/
removeMacro() {
}
/**
* Removes digital signature from this spreadsheet.
*/
removeDigitalSignature() {
}
/**
* Accepts all tracked changes in the workbook.
*/
acceptAllRevisions() {
}
/**
* Removes all external links in the workbook.
* NOTE: This member is now obsolete. Instead,
* please use ExternalLinkCollection.Clear() method.
* This method will be removed 12 months later since December 2021.
* Aspose apologizes for any inconvenience you may have experienced.
*/
removeExternalLinks() {
}
/**
* Gets theme color.
* @param {Number} type - ThemeColorType
* @return {Color} The theme color.
*/
getThemeColor(type) {
}
/**
* Sets the theme color
* @param {Number} type - ThemeColorType
* @param {Color} color - the theme color
*/
setThemeColor(type, color) {
}
/**
* Customs the theme.
* The length of colors should be 12.
* Array indexTheme type0Backgournd11Text12Backgournd23Text24Accent15Accent26Accent37Accent48Accent59Accent610Hyperlink11Followed Hyperlink
* @param {String} themeName - The theme name
* @param {Color[]} colors - The theme colors
*/
customTheme(themeName, colors) {
}
/**
* Copies the theme from another workbook.
* @param {Workbook} source - Source workbook.
*/
copyTheme(source) {
}
/**
* Indicates whether this workbook contains external links to other data sources.
* NOTE: This member is now obsolete. Instead,
* please use ExternalLinkCollection.Count to check whether there are external links in this workbook.
* This method will be removed 12 months later since December 2021.
* Aspose apologizes for any inconvenience you may have experienced.@return {boolean} Whether this workbook contains external links to other data sources.
*/
hasExernalLinks() {
}
/**
* Updates definition of custom functions.
* 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
* CustomFunctionDefinition.getArrayModeParameters(java.lang.String) 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.
* @param {CustomFunctionDefinition} definition - Special definition of custom functions for user's special requirement.
*/
updateCustomFunctionDefinition(definition) {
}
/**
* If this workbook contains external links to other data source,
* Aspose.Cells will attempt to retrieve the latest data from give sources.
* 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.
* @param {Workbook[]} 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
*/
updateLinkedDataSource(externalWorkbooks) {
}
/**
* Imports/Updates an XML data file into the workbook.
* @param {String} url - the url/path of the xml file.
* @param {String} sheetName - the destination sheet name.
* @param {Number} row - the destination row
* @param {Number} col - the destination column
*/
importXml(url, sheetName, row, col) {
}
/**
* Imports/Updates an XML data file into the workbook.
* @param {InputStream} stream - the xml file stream.
* @param {String} sheetName - the destination sheet name.
* @param {Number} row - the destination row.
* @param {Number} col - the destination column.
*/
importXml(stream, sheetName, row, col) {
}
/**
* Export XML data linked by the specified XML map.
* @param {String} mapName - name of the XML map that need to be exported
* @param {String} path - the export path
*/
exportXml(mapName, path) {
}
/**
* Export XML data linked by the specified XML map.
* @param {String} mapName - name of the XML map that need to be exported
* @param {OutputStream} stream - the export stream
*/
exportXml(mapName, stream) {
}
/**
* Sets digital signature to an spreadsheet file (Excel2007 and later).
* Only support adding Xmldsig Digital Signature
* @param {DigitalSignatureCollection} digitalSignatureCollection
*/
setDigitalSignature(digitalSignatureCollection) {
}
/**
* Adds digital signature to an OOXML spreadsheet file (Excel2007 and later).
* Only support adding Xmldsig Digital Signature to an OOXML spreadsheet file
* @param {DigitalSignatureCollection} digitalSignatureCollection
*/
addDigitalSignature(digitalSignatureCollection) {
}
/**
* Gets digital signature from file.
*/
getDigitalSignature() {
}
/**
* Removes personal information.
*/
removePersonalInformation() {
}
/**
* Performs application-defined tasks associated with freeing, releasing, or
* resetting unmanaged resources.
*/
dispose() {
}
/**
* Initializes a new instance of the Workbook class and open a stream.
* @param {ReadableStream} stream - The stream
* @param {Callback} callback - The callback function
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var readStream = fs.createReadStream("Book2.xlsx");
* aspose.cells.Workbook.createWorkbookFromStream(readStream, function(workbook, err) {
* if (err) {
* console.log("open workbook error");
* return;
* }
* workbook.save('result.xlsx');
* console.log('saved to file');
* });
*/
static createWorkbookFromStream(stream, callback) {
}
/**
* Initializes a new instance of the Workbook class and open a stream.
* @param {ReadableStream} stream - The stream
* @param {LoadOptions} loadOptions - The load options
* @param {Callback} callback - The callback function
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var readStream = fs.createReadStream("Book2.xlsx");
* var loadOptions = new aspose.cells.LoadOptions();
* aspose.cells.Workbook.createWorkbookFromStream(readStream, loadOptions, function(workbook, err) {
* if (err) {
* console.log("open workbook error");
* return;
* }
* workbook.save('result.xlsx');
* console.log('saved to file');
* });
*/
static createWorkbookFromStream(stream, loadOptions, callback) {
}
/**
* Save the workbook to the stream.
* @param {Workbook} workbook - The workbook object to save
* @param {WritableStream} stream - The stream
* @param {SaveOptions} saveOptions - The save options
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var saveOptions = new aspose.cells.XlsSaveOptions();
* var writeStream = fs.createWriteStream("result-stream.xls");
* aspose.cells.Workbook.saveToStream(workbook, writeStream, saveOptions);
*/
static save(workbook, stream, saveOptions) {
}
/**
* Save the workbook to the stream.
* @param {Workbook} workbook - The workbook object to save
* @param {WritableStream} stream - The stream
* @param {Number} saveFormat - The save file format type
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var writeStream = fs.createWriteStream("result-stream.xlsx");
* aspose.cells.Workbook.saveToStream(workbook, writeStream, aspose.cells.SaveFormat.XLSX);
*/
static save(workbook, stream, saveFormat) {
}
}
/**
* Encapsulates the object that represents a designer spreadsheet.
*/
class WorkbookDesigner {
/**
* Initializes a new instance of the WorkbookDesigner class.
*/
constructor() {
}
/**
* Initializes a new instance of the WorkbookDesigner class.
* @param {Workbook} workbook -
* The template workbook file.
*/
constructor_overload$1(workbook) {
}
/**
* Gets and sets the Workbook object.
*/
getWorkbook() {
}
/**
* Gets and sets the Workbook object.
*/
setWorkbook(value) {
}
/**
* Indicates whether repeating formulas with subtotal row.
*/
getRepeatFormulasWithSubtotal() {
}
/**
* Indicates whether repeating formulas with subtotal row.
*/
setRepeatFormulasWithSubtotal(value) {
}
/**
* If TRUE, Null will be inserted if the value is "";
*/
getUpdateEmptyStringAsNull() {
}
/**
* If TRUE, Null will be inserted if the value is "";
*/
setUpdateEmptyStringAsNull(value) {
}
/**
* Indicates if references in other worksheets will be updated.
*/
getUpdateReference() {
}
/**
* Indicates if references in other worksheets will be updated.
*/
setUpdateReference(value) {
}
/**
* Indicates whether formulas should be calculated.
*/
getCalculateFormula() {
}
/**
* Indicates whether formulas should be calculated.
*/
setCalculateFormula(value) {
}
/**
* Indicates whether processing the smart marker line by line.
* The default value is true.
* If False, the template file must contain a range which is named as "_CellsSmartMarkers".
*/
getLineByLine() {
}
/**
* Indicates whether processing the smart marker line by line.
* The default value is true.
* If False, the template file must contain a range which is named as "_CellsSmartMarkers".
*/
setLineByLine(value) {
}
/**
* Clears all data sources.
*/
clearDataSource() {
}
/**
* @param {String} variable
* @param {String} data
*/
setJsonDataSource(variable, data) {
}
/**
* Sets data binding to a variable.
* @param {String} variable - Variable name created using smart marker.
* @param {Object} data - Source data.
*/
setDataSource(variable, data) {
}
/**
* Processes the smart markers and populates the data source values.
*/
process() {
}
/**
* Processes the smart markers and populates the data source values.
* @param {boolean} isPreserved - True if the unrecognized smart marker is preserved.
*/
process(isPreserved) {
}
/**
* Processes the smart markers and populates the data source values.
* This method works on worksheet level.
* @param {Number} sheetIndex - Worksheet index.
* @param {boolean} isPreserved - True if the unrecognized smart marker is preserved.
*/
process(sheetIndex, isPreserved) {
}
/**
* Returns a collection of smart markers in a spreadsheet.
* A string array is created on every call. The array is sorted and duplicated values are removed.@return {String[]} A collection of smart markers
*/
getSmartMarkers() {
}
}
/**
* Represents the meta data.
*/
class WorkbookMetadata {
/**
* Create the meta data object.
* @param {String} fileName
* @param {MetadataOptions} options
*/
constructor(fileName, options) {
}
/**
* Gets the options of the metadata.
*/
getOptions() {
}
/**
* Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
*/
getBuiltInDocumentProperties() {
}
/**
* Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.
*/
getCustomDocumentProperties() {
}
/**
* Save the modified metadata to the file.
* @param {String} fileName - The file name.
*/
save(fileName) {
}
}
/**
* Workbook printing preview.
*/
class WorkbookPrintingPreview {
/**
* The construct of WorkbookPrintingPreview
* @param {Workbook} workbook - Indicate which workbook to be printed.
* @param {ImageOrPrintOptions} options - ImageOrPrintOptions contains some property of output
*/
constructor(workbook, options) {
}
/**
* Evaluate the total page count of this workbook
*/
getEvaluatedPageCount() {
}
}
/**
* Represents a Workbook render.
* The constructor of this class , must be used after modification of pagesetup, cell style.
*/
class WorkbookRender {
/**
* The construct of WorkbookRender
* @param {Workbook} workbook - Indicate which workbook to be rendered.
* @param {ImageOrPrintOptions} options - ImageOrPrintOptions contains some property of output image
*/
constructor(workbook, options) {
}
/**
* Gets the total page count of workbook.
*/
getPageCount() {
}
/**
* Get page size in inch of output image.
* @param {Number} pageIndex - The page index is based on zero.
* @return {float[]} Page size of image, [0] for width and [1] for height
*/
getPageSizeInch(pageIndex) {
}
/**
* Render whole workbook as Tiff Image to a file.
* @param {String} filename - the filename of the output image
*/
toImage(filename) {
}
/**
* Render certain page to a file.
* @param {Number} pageIndex - indicate which page is to be converted
* @param {String} fileName - filename of the output image
*/
toImage(pageIndex, fileName) {
}
/**
* Render certain page to a stream.
* @param {Number} pageIndex - indicate which page is to be converted
* @param {OutputStream} stream - the stream of the output image
*/
toImage(pageIndex, stream) {
}
/**
* Render workbook to Printer
* @param {String} printerName - the name of the printer , for example: "Microsoft Office Document Image Writer"
*/
toPrinter(printerName) {
}
/**
* Render workbook to Printer
* @param {String} printerName - the name of the printer , for example: "Microsoft Office Document Image Writer"
* @param {String} jobName - set the print job name
*/
toPrinter(printerName, jobName) {
}
/**
* Render whole workbook as Tiff Image to stream.
* @param {WorkbookRender} workbookRender - The WorkbookRender object
* @param {WritableStream} stream - The stream of the output image
* @example
* var aspose = aspose || {};
* aspose.cells = require("aspose.cells");
* var fs = require("fs");
* var workbook = new aspose.cells.Workbook("Book2.xlsx");
* var imgOptions = new aspose.cells.ImageOrPrintOptions();
* imgOptions.setHorizontalResolution(200);
* imgOptions.setVerticalResolution(300);
* imgOptions.setSaveFormat(aspose.cells.SaveFormat.XPS);
* var workbookRender = new aspose.cells.WorkbookRender(workbook, imgOptions);
* var imgWriteStream = fs.createWriteStream("workbook.xps");
* aspose.cells.WorkbookRender.toImageStream(workbookRender, imgWriteStream);
*/
static toImageStream(workbookRender, stream) {
}
}
/**
* Represents all settings of the workbook.
* @hideconstructor
*/
class WorkbookSettings {
/**
* Gets and sets the stream provider for external resource.
* NOTE: This member is now obsolete. Instead,
* please use ResourceProvider property.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStreamProvider() {
}
/**
* Gets and sets the stream provider for external resource.
* NOTE: This member is now obsolete. Instead,
* please use ResourceProvider property.
* This property will be removed 12 months later since June 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStreamProvider(value) {
}
/**
* Gets and sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
*/
getResourceProvider() {
}
/**
* Gets and sets the stream provider for external resource, such as loading image data for picture of type "LinkToFile".
*/
setResourceProvider(value) {
}
/**
* Gets and sets the author of the file.
* It''s not set, check BuiltInDocumentPropertyCollection.Author first, then check the user of Environment.
*/
getAuthor() {
}
/**
* Gets and sets the author of the file.
* It''s not set, check BuiltInDocumentPropertyCollection.Author first, then check the user of Environment.
*/
setAuthor(value) {
}
/**
* Indicates whether checking custom number format when setting Style.Custom.
*/
getCheckCustomNumberFormat() {
}
/**
* Indicates whether checking custom number format when setting Style.Custom.
*/
setCheckCustomNumberFormat(value) {
}
/**
* Enable macros;
* Now it only works when copying a worksheet to other worksheet in a workbook.
*/
getEnableMacros() {
}
/**
* Enable macros;
* Now it only works when copying a worksheet to other worksheet in a workbook.
*/
setEnableMacros(value) {
}
/**
* Gets or sets a value which represents if the workbook uses the 1904 date system.
*/
getDate1904() {
}
/**
* Gets or sets a value which represents if the workbook uses the 1904 date system.
*/
setDate1904(value) {
}
/**
* Gets the protection type of the workbook.
* The value of the property is ProtectionType integer constant.
*/
getProtectionType() {
}
/**
* Indicates whether and how to show objects in the workbook.
* The value of the property is DisplayDrawingObjects integer constant.
*/
getDisplayDrawingObjects() {
}
/**
* Indicates whether and how to show objects in the workbook.
* The value of the property is DisplayDrawingObjects integer constant.
*/
setDisplayDrawingObjects(value) {
}
/**
* Width of worksheet tab bar (in 1/1000 of window width).
*/
getSheetTabBarWidth() {
}
/**
* Width of worksheet tab bar (in 1/1000 of window width).
*/
setSheetTabBarWidth(value) {
}
/**
* Get or sets a value whether the Workbook tabs are displayed.
* The default value is true.
* @exampleThe following code hides the Sheet Tabs and Tab Scrolling Buttons for the spreadsheet.
* // Hide the spreadsheet tabs.
* workbook.getSettings().setShowTabs(false);
*/
getShowTabs() {
}
/**
* Get or sets a value whether the Workbook tabs are displayed.
* The default value is true.
* @exampleThe following code hides the Sheet Tabs and Tab Scrolling Buttons for the spreadsheet.
* // Hide the spreadsheet tabs.
* workbook.getSettings().setShowTabs(false);
*/
setShowTabs(value) {
}
/**
* Gets or sets the first visible worksheet tab.
*/
getFirstVisibleTab() {
}
/**
* Gets or sets the first visible worksheet tab.
*/
setFirstVisibleTab(value) {
}
/**
* Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
* The default value is true.
* @exampleThe following code makes the horizontal scroll bar invisible for the spreadsheet.
* // Hide the horizontal scroll bar of the Excel file.
* workbook.getSettings().setHScrollBarVisible(false);
*/
isHScrollBarVisible() {
}
/**
* Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar.
* The default value is true.
* @exampleThe following code makes the horizontal scroll bar invisible for the spreadsheet.
* // Hide the horizontal scroll bar of the Excel file.
* workbook.getSettings().setHScrollBarVisible(false);
*/
setHScrollBarVisible(value) {
}
/**
* Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
* The default value is true.
* @exampleThe following code makes the vertical scroll bar invisible for the spreadsheet.
* // Hide the vertical scroll bar of the Excel file.
* workbook.getSettings().setVScrollBarVisible(false);
*/
isVScrollBarVisible() {
}
/**
* Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar.
* The default value is true.
* @exampleThe following code makes the vertical scroll bar invisible for the spreadsheet.
* // Hide the vertical scroll bar of the Excel file.
* workbook.getSettings().setVScrollBarVisible(false);
*/
setVScrollBarVisible(value) {
}
/**
* Gets or sets a value that indicates whether the Workbook is shared.
* The default value is false.
*/
getShared() {
}
/**
* Gets or sets a value that indicates whether the Workbook is shared.
* The default value is false.
*/
setShared(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the regional settings for workbook.
* The value of the property is CountryCode integer constant.
* 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() {
}
/**
* Gets or sets the regional settings for workbook.
* The value of the property is CountryCode integer constant.
* 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) {
}
/**
* Gets or sets the Locale used by this workbook.
* Returns null if neither Locale nor Region is set.
*/
getLocale() {
}
/**
* Gets or sets the Locale used by this workbook.
* Returns null if neither Locale nor Region is set.
*/
setLocale(value) {
}
/**
* Gets and sets the globalization settings.
*/
getGlobalizationSettings() {
}
/**
* Gets and sets the globalization settings.
*/
setGlobalizationSettings(value) {
}
/**
* Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
*/
getNumberDecimalSeparator() {
}
/**
* Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region.
*/
setNumberDecimalSeparator(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setNumberGroupSeparator(value) {
}
/**
* Represents Workbook file encryption password.
*/
getPassword() {
}
/**
* Represents Workbook file encryption password.
*/
setPassword(value) {
}
/**
* Provides access to the workbook write protection options.
*/
getWriteProtection() {
}
/**
* Gets a value that indicates whether a password is required to open this workbook.
*/
isEncrypted() {
}
/**
* Gets a value that indicates whether the structure or window of the Workbook is protected.
*/
isProtected() {
}
/**
* Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
* The default value is false now. It's same as MS Excel 2013.
*/
isDefaultEncrypted() {
}
/**
* Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked.
* The default value is false now. It's same as MS Excel 2013.
*/
setDefaultEncrypted(value) {
}
/**
* Represents whether the generated spreadsheet will be opened Minimized.
*/
isMinimized() {
}
/**
* Represents whether the generated spreadsheet will be opened Minimized.
*/
setMinimized(value) {
}
/**
* Indicates whether this workbook is hidden.
*/
isHidden() {
}
/**
* Indicates whether this workbook is hidden.
*/
setHidden(value) {
}
/**
* Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
*/
getAutoCompressPictures() {
}
/**
* Specifies a boolean value that indicates the application automatically compressed pictures in the workbook.
*/
setAutoCompressPictures(value) {
}
/**
* True if personal information can be removed from the specified workbook.
*/
getRemovePersonalInformation() {
}
/**
* True if personal information can be removed from the specified workbook.
*/
setRemovePersonalInformation(value) {
}
/**
* Gets and sets whether hide the field list for the PivotTable.
*/
getHidePivotFieldList() {
}
/**
* Gets and sets whether hide the field list for the PivotTable.
*/
setHidePivotFieldList(value) {
}
/**
* Gets and sets how updates external links when the workbook is opened.
* The value of the property is UpdateLinksType integer constant.
*/
getUpdateLinksType() {
}
/**
* Gets and sets how updates external links when the workbook is opened.
* The value of the property is UpdateLinksType integer constant.
*/
setUpdateLinksType(value) {
}
/**
* Gets the max row index, zero-based.
* Returns 65535 if the file format is Excel97-2003;
*/
getMaxRow() {
}
/**
* Gets the max column index, zero-based.
* Returns 255 if the file format is Excel97-2003;
*/
getMaxColumn() {
}
/**
* The distance from the left edge of the client area to the left edge of the window, in unit of point.
*/
getWindowLeft() {
}
/**
* The distance from the left edge of the client area to the left edge of the window, in unit of point.
*/
setWindowLeft(value) {
}
/**
* The distance from the left edge of the client area to the left edge of the window.
* In unit of inch.
*/
getWindowLeftInch() {
}
/**
* The distance from the left edge of the client area to the left edge of the window.
* In unit of inch.
*/
setWindowLeftInch(value) {
}
/**
* The distance from the left edge of the client area to the left edge of the window.
* In unit of centimeter.
*/
getWindowLeftCM() {
}
/**
* The distance from the left edge of the client area to the left edge of the window.
* In unit of centimeter.
*/
setWindowLeftCM(value) {
}
/**
* The distance from the top edge of the client area to the top edge of the window, in unit of point.
*/
getWindowTop() {
}
/**
* The distance from the top edge of the client area to the top edge of the window, in unit of point.
*/
setWindowTop(value) {
}
/**
* The distance from the top edge of the client area to the top edge of the window, in unit of inch.
*/
getWindowTopInch() {
}
/**
* The distance from the top edge of the client area to the top edge of the window, in unit of inch.
*/
setWindowTopInch(value) {
}
/**
* The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
*/
getWindowTopCM() {
}
/**
* The distance from the top edge of the client area to the top edge of the window, in unit of centimeter.
*/
setWindowTopCM(value) {
}
/**
* The width of the window, in unit of point.
*/
getWindowWidth() {
}
/**
* The width of the window, in unit of point.
*/
setWindowWidth(value) {
}
/**
* The width of the window, in unit of inch.
*/
getWindowWidthInch() {
}
/**
* The width of the window, in unit of inch.
*/
setWindowWidthInch(value) {
}
/**
* The width of the window, in unit of centimeter.
*/
getWindowWidthCM() {
}
/**
* The width of the window, in unit of centimeter.
*/
setWindowWidthCM(value) {
}
/**
* The height of the window, in unit of point.
*/
getWindowHeight() {
}
/**
* The height of the window, in unit of point.
*/
setWindowHeight(value) {
}
/**
* The height of the window, in unit of inch.
*/
getWindowHeightInch() {
}
/**
* The height of the window, in unit of inch.
*/
setWindowHeightInch(value) {
}
/**
* The height of the window, in unit of centimeter.
*/
getWindowHeightCM() {
}
/**
* The height of the window, in unit of centimeter.
*/
setWindowHeightCM(value) {
}
/**
* Indicates whether update adjacent cells' border.
* 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() {
}
/**
* Indicates whether update adjacent cells' border.
* 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) {
}
/**
* Gets and sets the number of significant digits.
* The default value is CellsHelper.SignificantDigits.
* Only could be 15 or 17 now.
*/
getSignificantDigits() {
}
/**
* Gets and sets the number of significant digits.
* The default value is CellsHelper.SignificantDigits.
* Only could be 15 or 17 now.
*/
setSignificantDigits(value) {
}
/**
* Indicates whether check compatibility with earlier versions when saving workbook.
* The default value is true.
* Only for Excel97-2003 xls or xlt files.
*/
getCheckCompatibility() {
}
/**
* Indicates whether check compatibility with earlier versions when saving workbook.
* The default value is true.
* Only for Excel97-2003 xls or xlt files.
*/
setCheckCompatibility(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Indicates whether the file is marked for auto-recovery.
*/
getAutoRecover() {
}
/**
* Indicates whether the file is marked for auto-recovery.
*/
setAutoRecover(value) {
}
/**
* indicates whether the application last saved the workbook file after a crash.
*/
getCrashSave() {
}
/**
* indicates whether the application last saved the workbook file after a crash.
*/
setCrashSave(value) {
}
/**
* indicates whether the application last opened the workbook for data recovery.
*/
getDataExtractLoad() {
}
/**
* indicates whether the application last opened the workbook for data recovery.
*/
setDataExtractLoad(value) {
}
/**
* Indicates whether the application last opened the workbook in safe or repair mode.
*/
getRepairLoad() {
}
/**
* Indicates whether the application last opened the workbook in safe or repair mode.
*/
setRepairLoad(value) {
}
/**
* Specifies the incremental public release of the application.
*/
getBuildVersion() {
}
/**
* Specifies the incremental public release of the application.
*/
setBuildVersion(value) {
}
/**
* 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.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* 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.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets and sets the default print paper size.
* The value of the property is PaperSizeType integer constant.
* If there is no setting about paper size,MS Excel will use default printer's setting.
*/
getPaperSize() {
}
/**
* Gets and sets the default print paper size.
* The value of the property is PaperSizeType integer constant.
* If there is no setting about paper size,MS Excel will use default printer's setting.
*/
setPaperSize(value) {
}
/**
* Gets and sets the max row number of shared formula.
* If the number is too large, the autofilter works very slow in MS Excel 2013.
*/
getMaxRowsOfSharedFormula() {
}
/**
* Gets and sets the max row number of shared formula.
* If the number is too large, the autofilter works very slow in MS Excel 2013.
*/
setMaxRowsOfSharedFormula(value) {
}
/**
* Specifies the OOXML version for the output document. The default value is Ecma376_2006.
* The value of the property is OoxmlCompliance integer constant.
* Only for .xlsx files.
*/
getCompliance() {
}
/**
* Specifies the OOXML version for the output document. The default value is Ecma376_2006.
* The value of the property is OoxmlCompliance integer constant.
* Only for .xlsx files.
*/
setCompliance(value) {
}
/**
* Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell
*/
getQuotePrefixToStyle() {
}
/**
* Indicates whether setting Style.QuotePrefix property when entering the string value(which starts with single quote mark ) to the cell
*/
setQuotePrefixToStyle(value) {
}
/**
* Gets the settings for formula-related features.
*/
getFormulaSettings() {
}
/**
* Releases resources.
*/
dispose() {
}
/**
* Gets the default theme font name.
* @param {Number} type - FontSchemeType
* @return {String}
*/
getThemeFont(type) {
}
/**
* Set the type of print orientation for the whole workbook.
* @param {Number} pageOrientationType - PageOrientationType
*/
setPageOrientationType(pageOrientationType) {
}
}
/**
* Encapsulates the object that represents a single worksheet.
* @example
* var workbook = new aspose.cells.Workbook();
* var sheet = workbook.getWorksheets().get(0);
* //Freeze panes at "AS40" with 10 rows and 10 columns
* sheet.freezePanes("AS40", 10, 10);
* //Add a hyperlink in Cell A1
* sheet.getHyperlinks().add("A1", 1, 1, "http://www.aspose.com");
* @hideconstructor
*/
class Worksheet {
/**
* Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version.
* This property can protect worksheet in all versions of Excel file and support advanced protection options in ExcelXP and above version.
*/
getProtection() {
}
/**
* Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
*/
getUniqueId() {
}
/**
* Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
*/
setUniqueId(value) {
}
/**
* Gets the workbook object which contains this sheet.
*/
getWorkbook() {
}
/**
* Gets the Cells collection.
*/
getCells() {
}
/**
* Gets QueryTableCollection in the worksheet.
*/
getQueryTables() {
}
/**
* Gets all pivot tables in this worksheet.
*/
getPivotTables() {
}
/**
* Represents worksheet type.
* The value of the property is SheetType integer constant.
*/
getType() {
}
/**
* Represents worksheet type.
* The value of the property is SheetType integer constant.
*/
setType(value) {
}
/**
* Gets or sets the name of the worksheet.
* 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() {
}
/**
* Gets or sets the name of the worksheet.
* 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) {
}
/**
* Indicates whether to show formulas or their results.
*/
getShowFormulas() {
}
/**
* Indicates whether to show formulas or their results.
*/
setShowFormulas(value) {
}
/**
* Gets or sets a value indicating whether the gridlines are visible.Default is true.
*/
isGridlinesVisible() {
}
/**
* Gets or sets a value indicating whether the gridlines are visible.Default is true.
*/
setGridlinesVisible(value) {
}
/**
* Gets or sets a value indicating whether the worksheet will display row and column headers.
* Default is true.
*/
isRowColumnHeadersVisible() {
}
/**
* Gets or sets a value indicating whether the worksheet will display row and column headers.
* Default is true.
*/
setRowColumnHeadersVisible(value) {
}
/**
* Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen.
* The value of the property is PaneStateType integer constant.
*/
getPaneState() {
}
/**
* True if zero values are displayed.
*/
getDisplayZeros() {
}
/**
* True if zero values are displayed.
*/
setDisplayZeros(value) {
}
/**
* Indicates if the specified worksheet is displayed from right to left instead of from left to right.
* Default is false.
*/
getDisplayRightToLeft() {
}
/**
* Indicates if the specified worksheet is displayed from right to left instead of from left to right.
* Default is false.
*/
setDisplayRightToLeft(value) {
}
/**
* Indicates whether to show outline.
*/
isOutlineShown() {
}
/**
* Indicates whether to show outline.
*/
setOutlineShown(value) {
}
/**
* Indicates whether this worksheet is selected when the workbook is opened.
*/
isSelected() {
}
/**
* Indicates whether this worksheet is selected when the workbook is opened.
*/
setSelected(value) {
}
/**
* Gets all ListObjects in this worksheet.
*/
getListObjects() {
}
/**
* Specifies the internal identifier for the sheet.
*/
getTabId() {
}
/**
* Specifies the internal identifier for the sheet.
*/
setTabId(value) {
}
/**
* Gets the HorizontalPageBreakCollection collection.
*/
getHorizontalPageBreaks() {
}
/**
* Gets the VerticalPageBreakCollection collection.
*/
getVerticalPageBreaks() {
}
/**
* Gets the HyperlinkCollection collection.
*/
getHyperlinks() {
}
/**
* Represents the page setup description in this sheet.
*/
getPageSetup() {
}
/**
* Represents auto filter for the specified worksheet.
*/
getAutoFilter() {
}
/**
* Indicates whether this worksheet has auto filter.
*/
hasAutofilter() {
}
/**
* Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
*/
getTransitionEvaluation() {
}
/**
* Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
*/
setTransitionEvaluation(value) {
}
/**
* Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
*/
getTransitionEntry() {
}
/**
* Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
*/
setTransitionEntry(value) {
}
/**
* Indicates the visible state for this sheet.
* The value of the property is VisibilityType integer constant.
*/
getVisibilityType() {
}
/**
* Indicates the visible state for this sheet.
* The value of the property is VisibilityType integer constant.
*/
setVisibilityType(value) {
}
/**
* Represents if the worksheet is visible.
*/
isVisible() {
}
/**
* Represents if the worksheet is visible.
*/
setVisible(value) {
}
/**
* Gets the sparkline groups in the worksheet.
*/
getSparklineGroups() {
}
/**
* Gets a Chart collection
*/
getCharts() {
}
/**
* Gets the Comment collection.
*/
getComments() {
}
/**
* Gets a Picture collection.
*/
getPictures() {
}
/**
* Gets a TextBox collection.
*/
getTextBoxes() {
}
/**
* Gets a CheckBox collection.
*/
getCheckBoxes() {
}
/**
* Represents a collection of OleObject in a worksheet.
*/
getOleObjects() {
}
/**
* Returns all drawing shapes in this worksheet.
*/
getShapes() {
}
/**
* Get the Slicer collection in the worksheet
*/
getSlicers() {
}
/**
* Get the Timeline collection in the worksheet
*/
getTimelines() {
}
/**
* Gets the index of sheet in the worksheet collection.
*/
getIndex() {
}
/**
* Indicates if the worksheet is protected.
*/
isProtected() {
}
/**
* Gets the data validation setting collection in the worksheet.
*/
getValidations() {
}
/**
* Gets the allow edit range collection in the worksheet.
*/
getAllowEditRanges() {
}
/**
* Gets error check setting applied on certain ranges.
*/
getErrorCheckOptions() {
}
/**
* Gets the outline on this worksheet.
*/
getOutline() {
}
/**
* Represents first visible row index.
*/
getFirstVisibleRow() {
}
/**
* Represents first visible row index.
*/
setFirstVisibleRow(value) {
}
/**
* Represents first visible column index.
*/
getFirstVisibleColumn() {
}
/**
* Represents first visible column index.
*/
setFirstVisibleColumn(value) {
}
/**
* Represents the scaling factor in percentage. It should be between 10 and 400.
* Please set the view type first.
*/
getZoom() {
}
/**
* Represents the scaling factor in percentage. It should be between 10 and 400.
* Please set the view type first.
*/
setZoom(value) {
}
/**
* Gets and sets the view type.
* The value of the property is ViewType integer constant.
*/
getViewType() {
}
/**
* Gets and sets the view type.
* The value of the property is ViewType integer constant.
*/
setViewType(value) {
}
/**
* Indicates whether the specified worksheet is shown in normal view or page break preview.
*/
isPageBreakPreview() {
}
/**
* Indicates whether the specified worksheet is shown in normal view or page break preview.
*/
setPageBreakPreview(value) {
}
/**
* Indicates whether the ruler is visible. This property is only applied for page break preview.
*/
isRulerVisible() {
}
/**
* Indicates whether the ruler is visible. This property is only applied for page break preview.
*/
setRulerVisible(value) {
}
/**
* Represents worksheet tab color.
* 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() {
}
/**
* Represents worksheet tab color.
* 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) {
}
/**
* Gets worksheet code name.
*/
getCodeName() {
}
/**
* Gets worksheet code name.
*/
setCodeName(value) {
}
/**
* Gets and sets worksheet background image.
*/
getBackgroundImage() {
}
/**
* Gets and sets worksheet background image.
*/
setBackgroundImage(value) {
}
/**
* Gets the ConditionalFormattings in the worksheet.
*/
getConditionalFormattings() {
}
/**
* Gets or sets the active cell in the worksheet.
*/
getActiveCell() {
}
/**
* Gets or sets the active cell in the worksheet.
*/
setActiveCell(value) {
}
/**
* Gets an object representing
* the identifier information associated with a worksheet.
* 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() {
}
/**
* Gets all SmartTagCollection objects of the worksheet.
*/
getSmartTagSetting() {
}
/**
* Gets the collection of Scenario.
*/
getScenarios() {
}
/**
* Gets collection of cells on this worksheet being watched in the 'watch window'.
*/
getCellWatches() {
}
/**
* Replaces all cells' text with a new string.
* @param {String} oldString - Old string value.
* @param {String} newString - New string value.
*/
replace(oldString, newString) {
}
/**
* Gets selected ranges of cells in the designer spreadsheet.
* @return {ArrayList} An java.util.ArrayList which contains selected ranges.
*/
getSelectedRanges() {
}
/**
* Gets automatic page breaks.
* Each cell area represents a paper.
* @param {ImageOrPrintOptions} options - The print options
* @return {CellArea[]} The automatic page breaks areas.
*/
getPrintingPageBreaks(options) {
}
/**
* Returns a string represents the current Worksheet object.
* @return {String}
*/
toString() {
}
/**
* Starts the session that uses caches to access the data in this worksheet.
* After finishing the access to the data, closeAccessCache(int) should
* be invoked with same options to clear all caches and recover normal access mode.
* @param {Number} opts - AccessCacheOptions
*/
startAccessCache(opts) {
}
/**
* Closes the session that uses caches to access the data in this worksheet.
* @param {Number} opts - AccessCacheOptions
*/
closeAccessCache(opts) {
}
/**
* Converts the formula reference style.
* @param {String} formula - The formula to be converted.
* @param {boolean} 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 {Number} baseCellRow - The row index of the base cell.
* @param {Number} baseCellColumn - The column index of the base cell.
* @return {String} The converted formula.
*/
convertFormulaReferenceStyle(formula, toR1C1, baseCellRow, baseCellColumn) {
}
/**
* Calculates a formula.
* @param {String} formula - Formula to be calculated.
* @return {Object} Calculated formula result.
*/
calculateFormula(formula) {
}
/**
* Calculates a formula expression directly.
* 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 calculateArrayFormula(java.lang.String, com.aspose.cells.CalculationOptions) instead.
* @param {String} formula - Formula to be calculated.
* @param {CalculationOptions} opts - Options for calculating formula
* @return {Object} Calculated result of given formula.
* The returned object may be of possible types of Cell.Value, or ReferredArea.
*/
calculateFormula(formula, opts) {
}
/**
* Calculates a formula expression directly.
* 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
* calculateArrayFormula(java.lang.String, com.aspose.cells.FormulaParseOptions, com.aspose.cells.CalculationOptions, int, int, int, int, com.aspose.cells.CalculationData) instead.
* @param {String} formula - Formula to be calculated.
* @param {FormulaParseOptions} pOpts - Options for parsing formula.
* @param {CalculationOptions} cOpts - Options for calculating formula.
* @param {Number} baseCellRow - The row index of the base cell.
* @param {Number} baseCellColumn - The column index of the base cell.
* @param {CalculationData} 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
* @return {Object} Calculated result of given formula.
* The returned object may be of possible types of Cell.Value, or ReferredArea.
*/
calculateFormula(formula, pOpts, cOpts, baseCellRow, baseCellColumn, calculationData) {
}
/**
* Calculates a formula as array formula.
* @param {String} formula - Formula to be calculated.
* @param {CalculationOptions} opts - Options for calculating formula
*/
calculateArrayFormula(formula, opts) {
}
/**
* Calculates a formula as array formula.
* 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.
* @param {String} formula - Formula to be calculated.
* @param {CalculationOptions} opts - Options for calculating formula
* @param {Number} 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 {Number} 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.
* @return {Object[][]} Calculated formula result.
*/
calculateArrayFormula(formula, opts, maxRowCount, maxColumnCount) {
}
/**
* Calculates a formula as array formula.
* 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.
* @param {String} formula - Formula to be calculated.
* @param {FormulaParseOptions} pOpts - Options for parsing formula
* @param {CalculationOptions} cOpts - Options for calculating formula
* @param {Number} baseCellRow - The row index of the base cell.
* @param {Number} baseCellColumn - The column index of the base cell.
* @param {Number} 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 {Number} 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} 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
* @return {Object[][]} Calculated formula result.
*/
calculateArrayFormula(formula, pOpts, cOpts, baseCellRow, baseCellColumn, maxRowCount, maxColumnCount, calculationData) {
}
/**
* Calculates all formulas in this worksheet.
* @param {CalculationOptions} options - Options for calculation
* @param {boolean} 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, recursive) {
}
/**
* Query cell areas that mapped/linked to the specific path of xml map.
* e.g. A xml map element structure:
* -RootElement
* |-Attribute1
* |-SubElement
* |-Attribute2
* |-Attribute3
* To query "Attribute1", path is "/RootElement/@Attribute1"
* To query "Attribute2", path is "/RootElement/SubElement/@Attribute2"
* To query whole "SubElement", path is "/RootElement/SubElement"
* @param {String} path - xml element path
* @param {XmlMap} xmlMap - Specify an xml map if you want to query for the specific path within a specific map
* @return {ArrayList} CellArea list that mapped/linked to the specific path of xml map, an empty list is returned if nothing is mapped/linked.
*/
xmlMapQuery(path, xmlMap) {
}
/**
* Refreshes all the PivotTables in this Worksheet.
*/
refreshPivotTables() {
}
/**
* Refreshes all the PivotTables in this Worksheet.
* @param {PivotTableRefreshOption} option -
* The option for refreshing data source of pivot table.
*/
refreshPivotTables(option) {
}
/**
* Performs application-defined tasks associated with freeing, releasing, or
* resetting unmanaged resources.
*/
dispose() {
}
/**
* Gets the window panes.
* If the window is not split or frozen.
*/
getPanes() {
}
/**
* Freezes panes at the specified cell in the worksheet.
* 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.
* @param {Number} row - Row index.
* @param {Number} column - Column index.
* @param {Number} freezedRows - Number of visible rows in top pane, no more than row index.
* @param {Number} freezedColumns - Number of visible columns in left pane, no more than column index.
*/
freezePanes(row, column, freezedRows, freezedColumns) {
}
/**
* Gets the freeze panes.
* @return {Number[]} Return null means the worksheet is not frozen
* 0:Row index;1:column;2:freezedRows;3:freezedRows
*/
getFreezedPanes() {
}
/**
* Splits window.
*/
split() {
}
/**
* Freezes panes at the specified cell in the worksheet.
* Row index and column index cannot all be zero. Number of rows and number of columns
* also cannot all be zero.
* @param {String} cellName - Cell name.
* @param {Number} freezedRows - Number of visible rows in top pane, no more than row index.
* @param {Number} freezedColumns - Number of visible columns in left pane, no more than column index.
*/
freezePanes(cellName, freezedRows, freezedColumns) {
}
/**
* Unfreezes panes in the worksheet.
*/
unFreezePanes() {
}
/**
* Removes split window.
*/
removeSplit() {
}
/**
* Adds page break.
* @param {String} cellName
*/
addPageBreaks(cellName) {
}
/**
* Copies contents and formats from another worksheet.
* @param {Worksheet} sourceSheet - Source worksheet.
*/
copy(sourceSheet) {
}
/**
* Copies contents and formats from another worksheet.
* 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.
* @param {Worksheet} sourceSheet - Source worksheet.
* @param {CopyOptions} copyOptions
*/
copy(sourceSheet, copyOptions) {
}
/**
* Autofits the column width.
* This method autofits a row based on content in a range of cells within the row.
* @param {Number} columnIndex - Column index.
* @param {Number} firstRow - First row index.
* @param {Number} lastRow - Last row index.
*/
autoFitColumn(columnIndex, firstRow, lastRow) {
}
/**
* Autofits all columns in this worksheet.
*/
autoFitColumns() {
}
/**
* Autofits all columns in this worksheet.
* @param {AutoFitterOptions} options - The auto fitting options
*/
autoFitColumns(options) {
}
/**
* Autofits the column width.
* AutoFitColumn is an imprecise function.
* @param {Number} columnIndex - Column index.
*/
autoFitColumn(columnIndex) {
}
/**
* Autofits the columns width.
* AutoFitColumn is an imprecise function.
* @param {Number} firstColumn - First column index.
* @param {Number} lastColumn - Last column index.
*/
autoFitColumns(firstColumn, lastColumn) {
}
/**
* Autofits the columns width.
* AutoFitColumn is an imprecise function.
* @param {Number} firstColumn - First column index.
* @param {Number} lastColumn - Last column index.
* @param {AutoFitterOptions} options - The auto fitting options
*/
autoFitColumns(firstColumn, lastColumn, options) {
}
/**
* Autofits the columns width.
* AutoFitColumn is an imprecise function.
* @param {Number} firstRow - First row index.
* @param {Number} firstColumn - First column index.
* @param {Number} lastRow - Last row index.
* @param {Number} lastColumn - Last column index.
*/
autoFitColumns(firstRow, firstColumn, lastRow, lastColumn) {
}
/**
* Autofits the columns width.
* AutoFitColumn is an imprecise function.
* @param {Number} firstRow - First row index.
* @param {Number} firstColumn - First column index.
* @param {Number} lastRow - Last row index.
* @param {Number} lastColumn - Last column index.
* @param {AutoFitterOptions} options - The auto fitting options
*/
autoFitColumns(firstRow, firstColumn, lastRow, lastColumn, options) {
}
/**
* Autofits the row height.
* This method autofits a row based on content in a range of cells within the row.
* @param {Number} rowIndex - Row index.
* @param {Number} firstColumn - First column index.
* @param {Number} lastColumn - Last column index.
*/
autoFitRow(rowIndex, firstColumn, lastColumn) {
}
/**
* Autofits the row height.
* This method autofits a row based on content in a range of cells within the row.
* @param {Number} rowIndex - Row index.
* @param {Number} firstColumn - First column index.
* @param {Number} lastColumn - Last column index.
* @param {AutoFitterOptions} options - The auto fitter options
*/
autoFitRow(rowIndex, firstColumn, lastColumn, options) {
}
/**
* Autofits all rows in this worksheet.
*/
autoFitRows() {
}
/**
* Autofits all rows in this worksheet.
* @param {boolean} onlyAuto -
* True,only autofits the row height when row height is not customed.
*/
autoFitRows(onlyAuto) {
}
/**
* Autofits all rows in this worksheet.
* @param {AutoFitterOptions} options - The auto fitter options
*/
autoFitRows(options) {
}
/**
* Autofits row height in a range.
* @param {Number} startRow - Start row index.
* @param {Number} endRow - End row index.
*/
autoFitRows(startRow, endRow) {
}
/**
* Autofits row height in a range.
* @param {Number} startRow - Start row index.
* @param {Number} endRow - End row index.
* @param {AutoFitterOptions} options - The options of auto fitter.
*/
autoFitRows(startRow, endRow, options) {
}
/**
* Autofits row height in a rectangle range.
* @param {Number} startRow - Start row index.
* @param {Number} endRow - End row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endColumn - End column index.
*/
autoFitRow(startRow, endRow, startColumn, endColumn) {
}
/**
* Autofits the row height.
* AutoFitRow is an imprecise function.
* @param {Number} rowIndex - Row index.
*/
autoFitRow(rowIndex) {
}
/**
* Filters data using complex criteria.
* @param {boolean} isFilter - Indicates whether filtering the list in place.
* @param {String} listRange - The list range.
* @param {String} criteriaRange - The criteria range.
* @param {String} copyTo - The range where copying data to.
* @param {boolean} uniqueRecordOnly - Only displaying or copying unique rows.
*/
advancedFilter(isFilter, listRange, criteriaRange, copyTo, uniqueRecordOnly) {
}
/**
* Removes the auto filter of the worksheet.
*/
removeAutoFilter() {
}
/**
* Sets the visible options.
* @param {boolean} isVisible - Whether the worksheet is visible
* @param {boolean} ignoreError - Whether to ignore error if this option is not valid.
*/
setVisible(isVisible, ignoreError) {
}
/**
* Selects a range.
* @param {Number} startRow - The start row.
* @param {Number} startColumn - The start column
* @param {Number} totalRows - The number of rows.
* @param {Number} totalColumns - The number of columns
* @param {boolean} removeOthers - True means removing other selected range and only select this range.
*/
selectRange(startRow, startColumn, totalRows, totalColumns, removeOthers) {
}
/**
* Removes all drawing objects in this worksheet.
*/
removeAllDrawingObjects() {
}
/**
* Clears all comments in designer spreadsheet.
*/
clearComments() {
}
/**
* Protects worksheet.
* This method protects worksheet without password. It can protect worksheet in all versions of Excel file.
* @param {Number} type - ProtectionType
*/
protect(type) {
}
/**
* Protects worksheet.
* This method can protect worksheet in all versions of Excel file.
* @param {Number} type - ProtectionType
* @param {String} password - Password.
* @param {String} 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.
* @example
* //Instantiating a Workbook object
* var excel = new aspose.cells.Workbook("Book2.xls");
* //Accessing the first worksheet in the Excel file
* var worksheet = excel.getWorksheets().get(0);
* //Protecting the worksheet with a password
* worksheet.protect(aspose.cells.ProtectionType.ALL, "aspose", null);
* //Saving the modified Excel file in default (that is Excel 20003) format
* excel.save("Book1.xls");
*/
protect(type, password, oldPassword) {
}
/**
* Unprotects worksheet.
* This method unprotects worksheet which is protected without password.
*/
unprotect() {
}
/**
* Unprotects worksheet.
* If the worksheet is protected without a password, you can set a null value or blank string to password parameter.
* @param {String} password - Password
*/
unprotect(password) {
}
/**
* Moves the sheet to another location in the spreadsheet.
* @param {Number} index - Destination sheet index.
*/
moveTo(index) {
}
}
/**
* Encapsulates a collection of Worksheet objects.
* @example
* var workbook = new aspose.cells.Workbook();
* var sheets = workbook.getWorksheets();
* //Add a worksheet
* sheets.add();
* //Change the name of a worksheet
* sheets.get(0).setName("First Sheet");
* //Set the active sheet to the second worksheet
* sheets.setActiveSheetIndex(1);
* @hideconstructor
*/
class WorksheetCollection {
/**
* Gets the list of task panes.
*/
getWebExtensionTaskPanes() {
}
/**
* Gets the list of task panes.
*/
getWebExtensions() {
}
/**
* Gets the list of threaded comment authors.
*/
getThreadedCommentAuthors() {
}
/**
* Indicates whether refresh all connections on opening file in MS Excel.
*/
isRefreshAllConnections() {
}
/**
* Indicates whether refresh all connections on opening file in MS Excel.
*/
setRefreshAllConnections(value) {
}
/**
* Gets the collection of all the Name objects in the spreadsheet.
*/
getNames() {
}
/**
* Represents the name of active worksheet when the spreadsheet is opened.
*/
getActiveSheetName() {
}
/**
* Represents the name of active worksheet when the spreadsheet is opened.
*/
setActiveSheetName(value) {
}
/**
* Represents the index of active worksheet when the spreadsheet is opened.
* Sheet index is zero based.
*/
getActiveSheetIndex() {
}
/**
* Represents the index of active worksheet when the spreadsheet is opened.
* Sheet index is zero based.
*/
setActiveSheetIndex(value) {
}
/**
* Gets the master differential formatting records.
*/
getDxfs() {
}
/**
* Gets and sets the XML maps in the workbook.
*/
getXmlMaps() {
}
/**
* Gets and sets the XML maps in the workbook.
*/
setXmlMaps(value) {
}
/**
* Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
* 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:
* TitleSubjectAuthorKeywordsCommentsTemplateLast AuthorRevision NumberApplication NameLast Print DateCreation DateLast Save TimeTotal Editing TimeNumber of PagesNumber of WordsNumber of CharactersSecurityCategoryFormatManagerCompanyNumber of BytesNumber of LinesNumber of ParagraphsNumber of SlidesNumber of NotesNumber of Hidden SlidesNumber of Multimedia Clips
* @example
* var doc = workbook.getWorksheets().getBuiltInDocumentProperties().get("Author");
* doc.setValue("John Smith");
*/
getBuiltInDocumentProperties() {
}
/**
* Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.
* @example
* excel.getWorksheets().getCustomDocumentProperties().add("Checked by", "Jane");
*/
getCustomDocumentProperties() {
}
/**
* Gets and Sets displayed size when Workbook file is used as an Ole object.
* Null means no ole size setting.
*/
getOleSize() {
}
/**
* Gets and Sets displayed size when Workbook file is used as an Ole object.
* Null means no ole size setting.
*/
setOleSize(value) {
}
/**
* Represents external links in a workbook.
*/
getExternalLinks() {
}
/**
* Gets TableStyles object.
*/
getTableStyles() {
}
/**
* Represents revision logs.
*/
getRevisionLogs() {
}
/**
*/
getCount() {
}
/**
* Gets the Worksheet element at the specified index.
* @param {Number} index - The zero based index of the element.
* @return {Worksheet} The element at the specified index.
*/
get(index) {
}
/**
* Gets the Worksheet element with the specified name.
* @param {String} sheetName - Worksheet name
* @return {Worksheet} The element with the specified name.
*/
get(sheetName) {
}
/**
* Sets displayed size when Workbook file is used as an Ole object.
* This method is generally used to adjust display size in ppt file or doc file.
* @param {Number} startRow - Start row index.
* @param {Number} endRow - End row index.
* @param {Number} startColumn - Start column index.
* @param {Number} endColumn - End column index.
*/
setOleSize(startRow, endRow, startColumn, endColumn) {
}
/**
* Clears pivot tables from the spreadsheet.
*/
clearPivottables() {
}
/**
* Refresh all pivot tables and charts with pivot source.
*/
refreshAll() {
}
/**
* Refreshes all the PivotTables in the Excel file.
*/
refreshPivotTables() {
}
/**
* Refreshes all the PivotTables in the Excel file.
* @param {PivotTableRefreshOption} option -
* The option for refreshing data source of the pivot tables.
*/
refreshPivotTables(option) {
}
/**
* Creates a Range object from an address of the range.
* @param {String} address - The address of the range.
* @param {Number} sheetIndex - The sheet index.
* @return {Range} A Range object
*/
createRange(address, sheetIndex) {
}
/**
* Creates a Range object from an address of the range.
* @param {String} address - The address of the range.
* @param {Number} sheetIndex - The sheet index.
* @return {UnionRange} A Range object
*/
createUnionRange(address, sheetIndex) {
}
/**
* Gets the worksheet by the code name.
* @param {String} codeName - Worksheet code name.
* @return {Worksheet} The element with the specified code name.
*/
getSheetByCodeName(codeName) {
}
/**
* Sorts the defined names.
* 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() {
}
/**
* Insert a worksheet.
* @param {Number} index - The sheet index
* @param {Number} sheetType - SheetType
* @return {Worksheet} Returns an inserted worksheet.
*/
insert(index, sheetType) {
}
/**
* Insert a worksheet.
* @param {Number} index - The sheet index
* @param {Number} sheetType - SheetType
* @param {String} sheetName - The sheet name.
* @return {Worksheet} Returns an inserted worksheet.
*/
insert(index, sheetType, sheetName) {
}
/**
* Adds a worksheet to the collection.
* @param {Number} type - SheetType
* @return {Number} Worksheet object index.
* @example
* var workbook = new aspose.cells.Workbook();
* workbook.getWorksheets().add(aspose.cells.SheetType.CHART);
* var cells = workbook.getWorksheets().get(0).getCells();
* cells.get("c2").putValue(5000);
* cells.get("c3").putValue(3000);
* cells.get("c4").putValue(4000);
* cells.get("c5").putValue(5000);
* cells.get("c6").putValue(6000);
* var charts = workbook.getWorksheets().get(1).getCharts();
* var chartIndex = charts.add(aspose.cells.ChartType.COLUMN, 10, 10, 20, 20);
* var chart = charts.get(chartIndex);
* chart.getNSeries().add("Sheet1!C2:C6", true);
*/
add(type) {
}
/**
* Swaps the two sheets.
* @param {Number} sheetIndex1 - The first worksheet.
* @param {Number} sheetIndex2 - The second worksheet.
*/
swapSheet(sheetIndex1, sheetIndex2) {
}
/**
* Adds a worksheet to the collection.
* @return {Number} Worksheet object index.
*/
add() {
}
/**
* Adds a worksheet to the collection.
* @param {String} sheetName - Worksheet name
* @return {Worksheet} Worksheet object.
*/
add(sheetName) {
}
/**
* Adds addin function into the workbook
* @param {String} addInFile - the file contains the addin functions
* @param {String} functionName - the addin function name
* @param {boolean} 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.
* @return {Number} ID of the data which contains given addin function
*/
registerAddInFunction(addInFile, functionName, lib) {
}
/**
* Adds addin function into the workbook
* @param {Number} id - ID of the data which contains addin functions,
* can be got by the first call of
* @param {String} functionName - the addin function name
* @return {String} URL of the addin file which contains addin functions
*/
registerAddInFunction(id, functionName) {
}
/**
* Removes the element at a specified name.
* @param {String} name - The name of the element to remove.
*/
removeAt(name) {
}
/**
* Removes the element at a specified index.
* @param {Number} index - The index value of the element to remove.
*/
removeAt(index) {
}
/**
* Clear all worksheets.
* A workbook must contains a worksheet.
*/
clear() {
}
/**
* Adds a worksheet to the collection and copies data from an existed worksheet.
* @param {String} sheetName - Name of source worksheet.
* @return {Number} Worksheet object index.
*/
addCopy(sheetName) {
}
/**
* Adds a worksheet to the collection and copies data from an existed worksheet.
* @param {Number} sheetIndex - Index of source worksheet.
* @return {Number} Worksheet object index.
*/
addCopy(sheetIndex) {
}
/**
* Copy a group of worksheets.
* @param {Worksheet[]} source - The source worksheets.
* @param {String[]} destSheetNames - The names of the copied sheets.
*/
addCopy(source, destSheetNames) {
}
/**
* Gets Range object by pre-defined name.
* @param {String} rangeName - Name of range.
* @return {Range} Range object.Returns null if the named range does not exist.
*/
getRangeByName(rangeName) {
}
/**
* Gets Range by pre-defined name or table's name
* @param {String} rangeName - Name of range or table's name.
* @param {Number} currentSheetIndex - The sheet index. -1 represents global .
* @param {boolean} includeTable - Indicates whether checking all tables.
* @return {Range}
*/
getRangeByName(rangeName, currentSheetIndex, includeTable) {
}
/**
* Gets all pre-defined named ranges in the spreadsheet.
* @return {Range[]} 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() {
}
/**
* Gets all pre-defined named ranges in the spreadsheet.
* @return {Range[]} An array of Range objects.Returns null if the named range does not exist.
*/
getNamedRangesAndTables() {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Specifies write protection settings for a workbook.
*/
class WriteProtection {
/**
*/
constructor() {
}
/**
* Gets and sets the author.
*/
getAuthor() {
}
/**
* Gets and sets the author.
*/
setAuthor(value) {
}
/**
* Indicates if the Read Only Recommended option is selected.
*/
getRecommendReadOnly() {
}
/**
* Indicates if the Read Only Recommended option is selected.
*/
setRecommendReadOnly(value) {
}
/**
* Indicates whether this workbook is write protected.
*/
isWriteProtected() {
}
/**
* Sets the protected password to modify the file.
*/
setPassword(value) {
}
/**
* Returns true if the specified password is the same as the write-protection password the file was protected with.
* @param {String} password - The specified password.
* @return {boolean}
*/
validatePassword(password) {
}
}
/**
* Represents the options for saving xlsb file.
*/
class XlsbSaveOptions {
/**
* Creates xlsb file save options.
*/
constructor() {
}
/**
* Creates xlsb file save options.
* NOTE: This constructor is now obsolete.
* Instead, please use XlsbSaveOptions() constructor.
* This property will be removed 12 months later since January 2021.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* Gets and sets the compression type for ooxml file.
* The value of the property is OoxmlCompressionType integer constant.The default value is OoxmlCompressionType.Level6.
*/
getCompressionType() {
}
/**
* Gets and sets the compression type for ooxml file.
* The value of the property is OoxmlCompressionType integer constant.The default value is OoxmlCompressionType.Level6.
*/
setCompressionType(value) {
}
/**
* Indicates whether exporting all column indexes for cells.
* The default value is true.
*/
getExportAllColumnIndexes() {
}
/**
* Indicates whether exporting all column indexes for cells.
* The default value is true.
*/
setExportAllColumnIndexes(value) {
}
/**
* The data provider for saving workbook in light mode.
*/
getLightCellsDataProvider() {
}
/**
* The data provider for saving workbook in light mode.
*/
setLightCellsDataProvider(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents the save options for the Excel 97-2003 file format: xls and xlt.
*/
class XlsSaveOptions {
/**
* Creates options for saving Excel 97-2003 xls file.
*/
constructor() {
}
/**
* Creates options for saving Excel 97-2003 xls/xlt file.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* The data provider for saving workbook in light mode.
*/
getLightCellsDataProvider() {
}
/**
* The data provider for saving workbook in light mode.
*/
setLightCellsDataProvider(value) {
}
/**
* Indicates whether saving a template file.
* NOTE: This member is now obsolete. Instead,
* please create XlsSaveOptions with corresponding save format(xlt for true and xls for false).
* This method will be removed 12 months later since August 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isTemplate() {
}
/**
* Indicates whether saving a template file.
* NOTE: This member is now obsolete. Instead,
* please create XlsSaveOptions with corresponding save format(xlt for true and xls for false).
* This method will be removed 12 months later since August 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setTemplate(value) {
}
/**
* Indicates whether matching font color because there are 56 colors in the standard color palette.
*/
getMatchColor() {
}
/**
* Indicates whether matching font color because there are 56 colors in the standard color palette.
*/
setMatchColor(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents Xml Data Binding information.
*/
class XmlColumnProperty {
/**
*/
constructor() {
}
}
/**
* Represents Xml Data Binding information.
* @hideconstructor
*/
class XmlDataBinding {
/**
* Gets source url of this data binding.
*/
getUrl() {
}
}
/**
* Represents the options of loading xml.
*/
class XmlLoadOptions {
/**
* Represents the options of loading xml file.
*/
constructor() {
}
/**
* Represents the options of loading xml file.
* @param {Number} type - LoadFormat
*/
constructor_overload$1(type) {
}
/**
* Gets and sets the start cell.
* Only works when the file is not speadsheetML or mapping xml to Excel.
*/
getStartCell() {
}
/**
* Gets and sets the start cell.
* Only works when the file is not speadsheetML or mapping xml to Excel.
*/
setStartCell(value) {
}
/**
* Indicates whether mapping xml to Excel.
* The default value is false.
*/
isXmlMap() {
}
/**
* Indicates whether mapping xml to Excel.
* The default value is false.
*/
setXmlMap(value) {
}
/**
* Indicates whether importing xml as multiple worksheets.
*/
containsMultipleWorksheets() {
}
/**
* Indicates whether importing xml as multiple worksheets.
*/
setContainsMultipleWorksheets(value) {
}
/**
* Indicates whether converting the value in xml file to numeric or date.
*/
getConvertNumericOrDate() {
}
/**
* Indicates whether converting the value in xml file to numeric or date.
*/
setConvertNumericOrDate(value) {
}
/**
* Gets and sets the format of numeric value.
*/
getNumberFormat() {
}
/**
* Gets and sets the format of numeric value.
*/
setNumberFormat(value) {
}
/**
* Gets and sets the format of date value.
*/
getDateFormat() {
}
/**
* Gets and sets the format of date value.
*/
setDateFormat(value) {
}
/**
* Indicates whether ignore attributes of the root element.
*/
getIgnoreRootAttributes() {
}
/**
* Indicates whether ignore attributes of the root element.
*/
setIgnoreRootAttributes(value) {
}
/**
* Gets the load format.
* The value of the property is LoadFormat integer constant.
*/
getLoadFormat() {
}
/**
* Gets and set the password of the workbook.
*/
getPassword() {
}
/**
* Gets and set the password of the workbook.
*/
setPassword(value) {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
getParsingFormulaOnOpen() {
}
/**
* Indicates whether parsing the formula when reading the file.
* Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file
* because the formulas in the files are stored with a string formula.
*/
setParsingFormulaOnOpen(value) {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
getParsingPivotCachedRecords() {
}
/**
* Indicates whether parsing pivot cached records when loading the file.
* The default value is false.
* Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
*/
setParsingPivotCachedRecords(value) {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
getLanguageCode() {
}
/**
* Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
* The value of the property is CountryCode integer constant.
*/
setLanguageCode(value) {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
getRegion() {
}
/**
* Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
* The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file,
* please reset it after reading the file.
*/
setRegion(value) {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
getLocale() {
}
/**
* Gets and sets the Locale used for workbook at the time the file was loaded.
*/
setLocale(value) {
}
/**
* Gets the default style settings for initializing styles of the workbook
*/
getDefaultStyleSettings() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFont() {
}
/**
* Sets the default standard font name
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFont(value) {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getStandardFontSize() {
}
/**
* Sets the default standard font size.
* NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings.
* This property will be removed 12 months later since March 2022.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setStandardFontSize(value) {
}
/**
* Gets and sets the interrupt monitor.
*/
getInterruptMonitor() {
}
/**
* Gets and sets the interrupt monitor.
*/
setInterruptMonitor(value) {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
getIgnoreNotPrinted() {
}
/**
* Ignore the data which are not printed if directly printing the file
* Only for xlsx file.
*/
setIgnoreNotPrinted(value) {
}
/**
* Check whether data is valid in the template file.
*/
getCheckDataValid() {
}
/**
* Check whether data is valid in the template file.
*/
setCheckDataValid(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setCheckExcelRestriction(value) {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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() {
}
/**
* Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
* 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) {
}
/**
* The filter to denote how to load data.
*/
getLoadFilter() {
}
/**
* The filter to denote how to load data.
*/
setLoadFilter(value) {
}
/**
* The data handler for processing cells data when reading template file.
*/
getLightCellsDataHandler() {
}
/**
* The data handler for processing cells data when reading template file.
*/
setLightCellsDataHandler(value) {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
getMemorySetting() {
}
/**
* Gets or sets the memory usage options.
* The value of the property is MemorySetting integer constant.
*/
setMemorySetting(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
getAutoFitterOptions() {
}
/**
* Gets and sets the auto fitter options
* Only for xlsx ,spreadsheetML file now.
*/
setAutoFitterOptions(value) {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
getAutoFilter() {
}
/**
* Indicates whether auto filtering the data when loading the files.
* Sometimes although autofilter is set, the corresponding rows is not hidden in the file.
* Now only works for SpreadSheetML file.
*/
setAutoFilter(value) {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
getFontConfigs() {
}
/**
* Gets and sets individual font configs.
* Only works for the Workbook which uses this LoadOptions to load.
*/
setFontConfigs(value) {
}
/**
* Indicates whether ignoring useless shapes.
* 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() {
}
/**
* Indicates whether ignoring useless shapes.
* 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) {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
getPreservePaddingSpacesInFormula() {
}
/**
* Indicates whether preserve those spaces and line breaks that are padded between formula tokens
* while getting and setting formulas.
* Default value is false.
* After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces
* will be set to the same value with this property.
*/
setPreservePaddingSpacesInFormula(value) {
}
/**
* Sets the default print paper size from default printer's setting.
* If there is no setting about paper size,MS Excel will use default printer's setting.
* @param {Number} type - PaperSizeType
*/
setPaperSize(type) {
}
}
/**
* Represents Xml map information.
* @hideconstructor
*/
class XmlMap {
/**
* Returns or sets the name of the object.
*/
getName() {
}
/**
* Returns or sets the name of the object.
*/
setName(value) {
}
/**
* Gets root element name.
*/
getRootElementName() {
}
/**
* Gets an XmlDataBinding of this map.
*/
getDataBinding() {
}
}
/**
* A collection of XmlMap objects that represent XmlMap information.
* @hideconstructor
*/
class XmlMapCollection {
/**
*/
getCount() {
}
/**
* Gets the xml map by the specific index.
* @param {Number} index - The index.
* @return {XmlMap} The xml map
*/
get(index) {
}
/**
* Add a XmlMap by the url/path of a xml/xsd file.
* @param {String} url - url/path of a xml/xsd file.
* @return {Number} XmlMap object index.
*/
add(url) {
}
/**
* Removes all XmlMaps.
*/
clear() {
}
/**
*/
removeAt(index) {
}
/**
*/
iterator() {
}
/**
* Reserved for internal use.
*/
get(index) {
}
/**
* Reserved for internal use.
*/
contains(value) {
}
/**
* Reserved for internal use.
*/
add(value) {
}
/**
* Reserved for internal use.
*/
indexOf(value) {
}
}
/**
* Represents the options of saving the workbook as an xml file.
*/
class XmlSaveOptions {
/**
* Creates options for saving xml file.
*/
constructor() {
}
/**
* Represents the indexes of exported sheets.
*/
getSheetIndexes() {
}
/**
* Represents the indexes of exported sheets.
*/
setSheetIndexes(value) {
}
/**
* Gets or sets the exporting range.
*/
getExportArea() {
}
/**
* Gets or sets the exporting range.
*/
setExportArea(value) {
}
/**
* Indicates whether the range contains header row.
*/
hasHeaderRow() {
}
/**
* Indicates whether the range contains header row.
*/
setHasHeaderRow(value) {
}
/**
* Indicates whether exporting xml map in the file.
*/
getXmlMapName() {
}
/**
* Indicates whether exporting xml map in the file.
*/
setXmlMapName(value) {
}
/**
* Indicates whether exporting sheet's name as the name of the element.
*/
getSheetNameAsElementName() {
}
/**
* Indicates whether exporting sheet's name as the name of the element.
*/
setSheetNameAsElementName(value) {
}
/**
* Indicates whether exporting data as attributes of element.
*/
getDataAsAttribute() {
}
/**
* Indicates whether exporting data as attributes of element.
*/
setDataAsAttribute(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Gets or sets warning callback.
*/
getWarningCallback() {
}
/**
* Gets or sets warning callback.
*/
setWarningCallback(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Represents the additional options when saving the file as the Xps.
*/
class XpsSaveOptions {
/**
* Creates options for saving xps file.
*/
constructor() {
}
/**
* Creates options for saving xps file.
* NOTE: This constructor is now obsolete.
* Instead, please use XpsSaveOptions() constructor.
* This property will be removed 12 months later since August 2022.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} saveFormat - SaveFormat
*/
constructor_overload$1(saveFormat) {
}
/**
* 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() {
}
/**
* 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.
*/
setDefaultFont(value) {
}
/**
* 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.
* Default is true.
*/
getCheckWorkbookDefaultFont() {
}
/**
* 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.
* Default is true.
*/
setCheckWorkbookDefaultFont(value) {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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() {
}
/**
* Indicates whether to check font compatibility for every character in text.
* 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) {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
isFontSubstitutionCharGranularity() {
}
/**
* Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
* Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
*/
setFontSubstitutionCharGranularity(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setOnePagePerSheet(value) {
}
/**
* 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() {
}
/**
* 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.
*/
setAllColumnsInOnePagePerSheet(value) {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
getIgnoreError() {
}
/**
* Indicates if you need to hide the error while rendering.
* The error can be error in shape, image, chart rendering, etc.
*/
setIgnoreError(value) {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
getOutputBlankPageWhenNothingToPrint() {
}
/**
* Indicates whether to output a blank page when there is nothing to print.
* Default is true.
*/
setOutputBlankPageWhenNothingToPrint(value) {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
getPageIndex() {
}
/**
* Gets or sets the 0-based index of the first page to save.
* Default is 0.
*/
setPageIndex(value) {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
getPageCount() {
}
/**
* Gets or sets the number of pages to save.
* Default is System.Int32.MaxValue which means all pages will be rendered..
*/
setPageCount(value) {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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() {
}
/**
* Indicates which pages will not be printed.
* The value of the property is PrintingPageType integer constant.
* 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) {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
getGridlineType() {
}
/**
* Gets or sets gridline type.
* The value of the property is GridlineType integer constant.
* Default is Dotted type.
*/
setGridlineType(value) {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
getTextCrossType() {
}
/**
* Gets or sets displaying text type when the text width is larger than cell width.
* The value of the property is TextCrossType integer constant.
*/
setTextCrossType(value) {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
getDefaultEditLanguage() {
}
/**
* Gets or sets default edit language.
* The value of the property is DefaultEditLanguage integer constant.
* It may display/render different layouts for text paragraph when different edit languages is set.
* Default is DefaultEditLanguage.AUTO.
*/
setDefaultEditLanguage(value) {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
getSheetSet() {
}
/**
* Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
*/
setSheetSet(value) {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
getDrawObjectEventHandler() {
}
/**
* Implements this interface to get DrawObject and Bound when rendering.
*/
setDrawObjectEventHandler(value) {
}
/**
* Control/Indicate progress of page saving process.
*/
getPageSavingCallback() {
}
/**
* Control/Indicate progress of page saving process.
*/
setPageSavingCallback(value) {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
getEmfRenderSetting() {
}
/**
* Setting for rendering Emf metafile.
* The value of the property is EmfRenderSetting integer constant.
* 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed.
* Default value is EmfRenderSetting.EMF_ONLY.
*/
setEmfRenderSetting(value) {
}
/**
* Gets the save file format.
* The value of the property is SaveFormat integer constant.
*/
getSaveFormat() {
}
/**
* Make the workbook empty after saving the file.
*/
getClearData() {
}
/**
* Make the workbook empty after saving the file.
*/
setClearData(value) {
}
/**
* The cached file folder is used to store some large data.
*/
getCachedFileFolder() {
}
/**
* The cached file folder is used to store some large data.
*/
setCachedFileFolder(value) {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
getValidateMergedAreas() {
}
/**
* Indicates whether validate merged cells before saving the file.
* The default value is false.
*/
setValidateMergedAreas(value) {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
getMergeAreas() {
}
/**
* Indicates whether merge the areas of conditional formatting and validation before saving the file.
* The default value is false.
*/
setMergeAreas(value) {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
getCreateDirectory() {
}
/**
* If true and the directory does not exist, the directory will be automatically created before saving the file.
* The default value is false.
*/
setCreateDirectory(value) {
}
/**
* Indicates whether sorting defined names before saving file.
*/
getSortNames() {
}
/**
* Indicates whether sorting defined names before saving file.
*/
setSortNames(value) {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
getSortExternalNames() {
}
/**
* Indicates whether sorting external defined names before saving file.
*/
setSortExternalNames(value) {
}
/**
* Indicates whether refreshing chart cache data
*/
getRefreshChartCache() {
}
/**
* Indicates whether refreshing chart cache data
*/
setRefreshChartCache(value) {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
getUpdateSmartArt() {
}
/**
* Indicates whether updating smart art setting.
* The default value is false.
* Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
*/
setUpdateSmartArt(value) {
}
}
/**
* Utility class containing constants.
* Cache options for data access. Can be combined with | operator for multiple options together.
* 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.
* @enum {number}
*/
const AccessCacheOptions = {
/**
* No cache for any data access.
*/
NONE,
/**
* 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,
/**
* 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.
*/
POSITION_AND_SIZE,
/**
* 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 #Error Cref: P:Aspose.Cells.Cells.Item(System.Int32,System.Int32)).
*/
CELLS_DATA,
/**
* Apply possible optimization for getting display-related results of
* cells(Cell.DisplayStringValue, Cell.getStyle(), Cell.getDisplayStyle(), etc.).
* Cells data and style-related objects(Cell/Row/Column styles, column width, etc.) should not be changed
* during the optimized access.
*/
CELL_DISPLAY,
/**
* 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.
*/
GET_FORMULA,
/**
* 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.
*/
SET_FORMULA,
/**
* 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 #Error Cref: P:Aspose.Cells.Cells.Item(System.Int32,System.Int32)).
*/
CALCULATE_FORMULA,
/**
* 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.
*/
CONDITIONAL_FORMATTING,
/**
* 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,
}
/**
* Utility class containing constants.
* Represents which kind of rows should be ajusted.
* @enum {number}
*/
const AdjustFontSizeForRowType = {
/**
* No adjsut.
*/
NONE,
/**
* If the row is empty, change font size to fit row height.
*/
EMPTY_ROWS,
}
/**
* Utility class containing constants.
* Represents the auto fill type.
* @enum {number}
*/
const AutoFillType = {
/**
* Copies the value and format of the source area to the target area
*/
COPY,
/**
* Automatically fills the target area with the value and format.
*/
DEFAULT,
/**
* Copies only the format of the source area to the target area,
*/
FORMATS,
/**
* Extend the value in the source area to the target area in the form of a series and copy format to the target area.
*/
SERIES,
/**
* Copies only the value of the source area to the target area,
*/
VALUES,
}
/**
* Utility class containing constants.
* Represents the type of auto fitting merged cells.
* @enum {number}
*/
const AutoFitMergedCellsType = {
/**
* Ignore merged cells.
* Default.
*/
NONE,
/**
* Only expands the height of the first row.
*/
FIRST_LINE,
/**
* Only expands the height of the last row.
*/
LAST_LINE,
/**
* Only expands the height of each row.
*/
EACH_LINE,
}
/**
* Utility class containing constants.
* Represents the type of auto fitting wrapped text.
* @enum {number}
*/
const AutoFitWrappedTextType = {
/**
* Works as MS Excel.
*/
DEFAULT,
/**
* Auto fit width with the longest paragraph.
*/
PARAGRAPH,
}
/**
* Utility class containing constants.
* Represents all built-in auto shape type.
* @enum {number}
*/
const AutoShapeType = {
/**
*/
NOT_PRIMITIVE,
/**
*/
RECTANGLE,
/**
*/
ROUNDED_RECTANGLE,
/**
*/
OVAL,
/**
*/
DIAMOND,
/**
*/
ISOSCELES_TRIANGLE,
/**
*/
RIGHT_TRIANGLE,
/**
*/
PARALLELOGRAM,
/**
*/
TRAPEZOID,
/**
*/
HEXAGON,
/**
*/
OCTAGON,
/**
*/
CROSS,
/**
*/
STAR_5,
/**
*/
RIGHT_ARROW,
/**
*/
HOME_PLATE,
/**
*/
CUBE,
/**
*/
BALLOON,
/**
*/
SEAL,
/**
*/
ARC,
/**
*/
LINE,
/**
*/
PLAQUE,
/**
*/
CAN,
/**
*/
DONUT,
/**
*/
TEXT_SIMPLE,
/**
*/
TEXT_OCTAGON,
/**
*/
TEXT_HEXAGON,
/**
*/
TEXT_CURVE,
/**
*/
TEXT_WAVE,
/**
*/
TEXT_RING,
/**
*/
TEXT_ON_CURVE,
/**
*/
MSOSPT_TEXT_ON_RING,
/**
*/
STRAIGHT_CONNECTOR,
/**
*/
BENT_CONNECTOR_2,
/**
*/
ELBOW_CONNECTOR,
/**
*/
BENT_CONNECTOR_4,
/**
*/
BENT_CONNECTOR_5,
/**
*/
CURVED_CONNECTOR_2,
/**
*/
CURVED_CONNECTOR,
/**
*/
CURVED_CONNECTOR_4,
/**
*/
CURVED_CONNECTOR_5,
/**
*/
LINE_CALLOUT_NO_BORDER_2,
/**
*/
LINE_CALLOUT_NO_BORDER_3,
/**
*/
LINE_CALLOUT_NO_BORDER_4,
/**
*/
LINE_CALLOUT_WITH_ACCENT_BAR_2,
/**
*/
LINE_CALLOUT_WITH_ACCENT_BAR_3,
/**
*/
LINE_CALLOUT_WITH_ACCENT_BAR_4,
/**
*/
LINE_CALLOUT_WITH_BORDER_2,
/**
*/
LINE_CALLOUT_WITH_BORDER_3,
/**
*/
LINE_CALLOUT_WITH_BORDER_4,
/**
*/
LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR_2,
/**
*/
LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR_3,
/**
*/
LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR_4,
/**
*/
DOWN_RIBBON,
/**
*/
UP_RIBBON,
/**
*/
CHEVRON,
/**
*/
REGULAR_PENTAGON,
/**
*/
NO_SYMBOL,
/**
*/
STAR_8,
/**
*/
STAR_16,
/**
*/
STAR_32,
/**
*/
RECTANGULAR_CALLOUT,
/**
*/
ROUNDED_RECTANGULAR_CALLOUT,
/**
*/
OVAL_CALLOUT,
/**
*/
WAVE,
/**
*/
FOLDED_CORNER,
/**
*/
LEFT_ARROW,
/**
*/
DOWN_ARROW,
/**
*/
UP_ARROW,
/**
*/
LEFT_RIGHT_ARROW,
/**
*/
UP_DOWN_ARROW,
/**
*/
EXPLOSION_1,
/**
*/
EXPLOSION_2,
/**
*/
LIGHTNING_BOLT,
/**
*/
HEART,
/**
*/
PICTURE_FRAME,
/**
*/
QUAD_ARROW,
/**
*/
LEFT_ARROW_CALLOUT,
/**
*/
RIGHT_ARROW_CALLOUT,
/**
*/
UP_ARROW_CALLOUT,
/**
*/
DOWN_ARROW_CALLOUT,
/**
*/
LEFT_RIGHT_ARROW_CALLOUT,
/**
*/
UP_DOWN_ARROW_CALLOUT,
/**
*/
QUAD_ARROW_CALLOUT,
/**
*/
BEVEL,
/**
*/
LEFT_BRACKET,
/**
*/
RIGHT_BRACKET,
/**
*/
LEFT_BRACE,
/**
*/
RIGHT_BRACE,
/**
*/
LEFT_UP_ARROW,
/**
*/
BENT_UP_ARROW,
/**
*/
BENT_ARROW,
/**
*/
STAR_24,
/**
*/
STRIPED_RIGHT_ARROW,
/**
*/
NOTCHED_RIGHT_ARROW,
/**
*/
BLOCK_ARC,
/**
*/
SMILEY_FACE,
/**
*/
VERTICAL_SCROLL,
/**
*/
HORIZONTAL_SCROLL,
/**
*/
CIRCULAR_ARROW,
/**
* A value that SHOULD NOT be used.
*/
NOTCHED_CIRCULAR_ARROW,
/**
*/
U_TURN_ARROW,
/**
*/
CURVED_RIGHT_ARROW,
/**
*/
CURVED_LEFT_ARROW,
/**
*/
CURVED_UP_ARROW,
/**
*/
CURVED_DOWN_ARROW,
/**
*/
CLOUD_CALLOUT,
/**
*/
CURVED_DOWN_RIBBON,
/**
*/
CURVED_UP_RIBBON,
/**
*/
FLOW_CHART_PROCESS,
/**
*/
FLOW_CHART_DECISION,
/**
*/
FLOW_CHART_DATA,
/**
*/
FLOW_CHART_PREDEFINED_PROCESS,
/**
*/
FLOW_CHART_INTERNAL_STORAGE,
/**
*/
FLOW_CHART_DOCUMENT,
/**
*/
FLOW_CHART_MULTIDOCUMENT,
/**
*/
FLOW_CHART_TERMINATOR,
/**
*/
FLOW_CHART_PREPARATION,
/**
*/
FLOW_CHART_MANUAL_INPUT,
/**
*/
FLOW_CHART_MANUAL_OPERATION,
/**
*/
FLOW_CHART_CONNECTOR,
/**
*/
FLOW_CHART_CARD,
/**
*/
FLOW_CHART_PUNCHED_TAPE,
/**
*/
FLOW_CHART_SUMMING_JUNCTION,
/**
*/
FLOW_CHART_OR,
/**
*/
FLOW_CHART_COLLATE,
/**
*/
FLOW_CHART_SORT,
/**
*/
FLOW_CHART_EXTRACT,
/**
*/
FLOW_CHART_MERGE,
/**
*/
FLOW_CHART_OFFLINE_STORAGE,
/**
*/
FLOW_CHART_STORED_DATA,
/**
*/
FLOW_CHART_SEQUENTIAL_ACCESS_STORAGE,
/**
*/
FLOW_CHART_MAGNETIC_DISK,
/**
*/
FLOW_CHART_DIRECT_ACCESS_STORAGE,
/**
*/
FLOW_CHART_DISPLAY,
/**
*/
FLOW_CHART_DELAY,
/**
* A plain text shape.
*/
TEXT_PLAIN_TEXT,
/**
* An octagonal text shape.
*/
TEXT_STOP,
/**
* A triangular text shape pointing upwards.
*/
TEXT_TRIANGLE,
/**
* A triangular text shape pointing downwards.
*/
TEXT_TRIANGLE_INVERTED,
/**
* A chevron text shape pointing upwards.
*/
TEXT_CHEVRON,
/**
* A chevron text shape pointing downwards.
*/
TEXT_CHEVRON_INVERTED,
/**
* A circular text shape, as if reading an inscription on the inside of a ring.
*/
TEXT_RING_INSIDE,
/**
* A circular text shape, as if reading an inscription on the outside of a ring.
*/
TEXT_RING_OUTSIDE,
/**
* An upward arching curved text shape.
*/
TEXT_ARCH_UP_CURVE,
/**
* A downward arching curved text shape.
*/
TEXT_ARCH_DOWN_CURVE,
/**
* A circular text shape.
*/
TEXT_CIRCLE_CURVE,
/**
* A text shape that resembles a button.
*/
TEXT_BUTTON_CURVE,
/**
* An upward arching text shape.
*/
TEXT_ARCH_UP_POUR,
/**
* A downward arching text shape.
*/
TEXT_ARCH_DOWN_POUR,
/**
* A circular text shape.
*/
TEXT_CIRCLE_POUR,
/**
* A text shape that resembles a button.
*/
TEXT_BUTTON_POUR,
/**
* An upward curving text shape.
*/
TEXT_CURVE_UP,
/**
* A downward curving text shape.
*/
TEXT_CURVE_DOWN,
/**
* A cascading text shape pointed upwards.
*/
TEXT_CASCADE_UP,
/**
* A cascading text shape pointed downwards.
*/
TEXT_CASCADE_DOWN,
/**
* A wavy text shape.
*/
TEXT_WAVE_1,
/**
* A wavy text shape.
*/
TEXT_WAVE_2,
/**
* A wavy text shape.
*/
TEXT_DOUBLE_WAVE_1,
/**
* A wavy text shape.
*/
TEXT_DOUBLE_WAVE_2,
/**
* A text shape that expands vertically in the middle.
*/
TEXT_INFLATE,
/**
* A text shape that shrinks vertically in the middle.
*/
TEXT_DEFLATE,
/**
* A text shape that expands downward in the middle.
*/
TEXT_INFLATE_BOTTOM,
/**
* A text shape that shrinks upwards in the middle.
*/
TEXT_DEFLATE_BOTTOM,
/**
* A text shape that expands upward in the middle.
*/
TEXT_INFLATE_TOP,
/**
* A text shape that shrinks downward in the middle.
*/
TEXT_DEFLATE_TOP,
/**
* A text shape where lower lines expand upward. Upper lines shrink to compensate.
*/
TEXT_DEFLATE_INFLATE,
/**
* A text shape where lines in the center expand vertically. Upper and lower lines shrink to compensate.
*/
TEXT_DEFLATE_INFLATE_DEFLATE,
/**
* A text shape that shrinks vertically on the right side.
*/
TEXT_FADE_RIGHT,
/**
* A text shape that shrinks vertically on the left side.
*/
TEXT_FADE_LEFT,
/**
* A text shape that shrinks horizontally on top.
*/
TEXT_FADE_UP,
/**
* A text shape that shrinks horizontally on bottom.
*/
TEXT_FADE_DOWN,
/**
* An upward slanted text shape.
*/
TEXT_SLANT_UP,
/**
* A downward slanted text shape.
*/
TEXT_SLANT_DOWN,
/**
* A text shape that is curved upwards as if being read on the side of a can.
*/
TEXT_CAN_UP,
/**
* A text shape that is curved downwards as if being read on the side of a can.
*/
TEXT_CAN_DOWN,
/**
*/
FLOW_CHART_ALTERNATE_PROCESS,
/**
*/
FLOW_CHART_OFFPAGE_CONNECTOR,
/**
*/
LINE_CALLOUT_NO_BORDER_1,
/**
*/
LINE_CALLOUT_WITH_ACCENT_BAR_1,
/**
*/
LINE_CALLOUT_WITH_BORDER_1,
/**
*/
LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR_1,
/**
*/
LEFT_RIGHT_UP_ARROW,
/**
*/
SUN,
/**
*/
MOON,
/**
* A shape enclosed in brackets.
*/
DOUBLE_BRACKET,
/**
* A shape enclosed in braces.
*/
DOUBLE_BRACE,
/**
*/
STAR_4,
/**
*/
DOUBLE_WAVE,
/**
*/
BLANK_ACTION_BUTTON,
/**
*/
HOME_ACTION_BUTTON,
/**
*/
HELP_ACTION_BUTTON,
/**
*/
INFORMATION_ACTION_BUTTON,
/**
*/
FORWARD_NEXT_ACTION_BUTTON,
/**
*/
BACK_PREVIOUS_ACTION_BUTTON,
/**
*/
END_ACTION_BUTTON,
/**
*/
BEGINNING_ACTION_BUTTON,
/**
*/
RETURN_ACTION_BUTTON,
/**
*/
DOCUMENT_ACTION_BUTTON,
/**
*/
SOUND_ACTION_BUTTON,
/**
*/
MOVIE_ACTION_BUTTON,
/**
* This value SHOULD NOT be used.
*/
HOST_CONTROL,
/**
*/
TEXT_BOX,
/**
*/
HEPTAGON,
/**
*/
DECAGON,
/**
*/
DODECAGON,
/**
*/
STAR_6,
/**
*/
STAR_7,
/**
*/
STAR_10,
/**
*/
STAR_12,
/**
*/
ROUND_SINGLE_CORNER_RECTANGLE,
/**
*/
ROUND_SAME_SIDE_CORNER_RECTANGLE,
/**
*/
ROUND_DIAGONAL_CORNER_RECTANGLE,
/**
*/
SNIP_ROUND_SINGLE_CORNER_RECTANGLE,
/**
*/
SNIP_SINGLE_CORNER_RECTANGLE,
/**
*/
SNIP_SAME_SIDE_CORNER_RECTANGLE,
/**
*/
SNIP_DIAGONAL_CORNER_RECTANGLE,
/**
*/
TEARDROP,
/**
*/
PIE,
/**
*/
HALF_FRAME,
/**
*/
L_SHAPE,
/**
*/
DIAGONAL_STRIPE,
/**
*/
CHORD,
/**
*/
CLOUD,
/**
*/
MATH_PLUS,
/**
*/
MATH_MINUS,
/**
*/
MATH_MULTIPLY,
/**
*/
MATH_DIVIDE,
/**
*/
MATH_EQUAL,
/**
*/
MATH_NOT_EQUAL,
/**
*/
LINE_INV,
/**
*/
NON_ISOSCELES_TRAPEZOID,
/**
*/
PIE_WEDGE,
/**
*/
LEFT_CIRCULAR_ARROW,
/**
*/
LEFT_RIGHT_CIRCULAR_ARROW,
/**
*/
SWOOSH_ARROW,
/**
*/
LEFT_RIGHT_RIBBON,
/**
*/
TEXT_NO_SHAPE,
/**
*/
GEAR_6,
/**
*/
GEAR_9,
/**
*/
FUNNEL,
/**
*/
CORNER_TABS,
/**
*/
SQUARE_TABS,
/**
*/
PLAQUE_TABS,
/**
*/
CHART_X,
/**
*/
CHART_STAR,
/**
*/
CHART_PLUS,
/**
*/
FRAME,
/**
*/
MODEL_3_D,
/**
* There is no such type in Excel
*/
ROUND_CALLOUT,
/**
* There is no such type in Excel
*/
TEXT_ARCH_LEFT_POUR,
/**
* There is no such type in Excel
*/
TEXT_ARCH_RIGHT_POUR,
/**
* There is no such type in Excel
*/
TEXT_ARCH_LEFT_CURVE,
/**
* There is no such type in Excel
*/
TEXT_ARCH_RIGHT_CURVE,
/**
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Represents the axis type.
* @enum {number}
*/
const AxisType = {
/**
* Category axis
*/
CATEGORY,
/**
* Value axis
*/
VALUE,
/**
* Series axis
*/
SERIES,
}
/**
* Utility class containing constants.
* Represents the display mode of the background.
* @enum {number}
*/
const BackgroundMode = {
/**
* Automatic
*/
AUTOMATIC,
/**
* Opaque
*/
OPAQUE,
/**
* Transparent
*/
TRANSPARENT,
}
/**
* Utility class containing constants.
* Enumerates cell background pattern types.
* @enum {number}
*/
const BackgroundType = {
/**
* Represents diagonal crosshatch pattern.
*/
DIAGONAL_CROSSHATCH,
/**
* Represents diagonal stripe pattern.
*/
DIAGONAL_STRIPE,
/**
* Represents 6.25% gray pattern
*/
GRAY_6,
/**
* Represents 12.5% gray pattern
*/
GRAY_12,
/**
* Represents 25% gray pattern.
*/
GRAY_25,
/**
* Represents 50% gray pattern.
*/
GRAY_50,
/**
* Represents 75% gray pattern.
*/
GRAY_75,
/**
* Represents horizontal stripe pattern.
*/
HORIZONTAL_STRIPE,
/**
* Represents no background.
*/
NONE,
/**
* Represents reverse diagonal stripe pattern.
*/
REVERSE_DIAGONAL_STRIPE,
/**
* Represents solid pattern.
*/
SOLID,
/**
* Represents thick diagonal crosshatch pattern.
*/
THICK_DIAGONAL_CROSSHATCH,
/**
* Represents thin diagonal crosshatch pattern.
*/
THIN_DIAGONAL_CROSSHATCH,
/**
* Represents thin diagonal stripe pattern.
*/
THIN_DIAGONAL_STRIPE,
/**
* Represents thin horizontal crosshatch pattern.
*/
THIN_HORIZONTAL_CROSSHATCH,
/**
* Represents thin horizontal stripe pattern.
*/
THIN_HORIZONTAL_STRIPE,
/**
* Represents thin reverse diagonal stripe pattern.
*/
THIN_REVERSE_DIAGONAL_STRIPE,
/**
* Represents thin vertical stripe pattern.
*/
THIN_VERTICAL_STRIPE,
/**
* Represents vertical stripe pattern.
*/
VERTICAL_STRIPE,
}
/**
* Utility class containing constants.
* Represents the shape used with the 3-D bar or column chart.
* @enum {number}
*/
const Bar3DShapeType = {
/**
* Box
*/
BOX,
/**
* PyramidToPoint
*/
PYRAMID_TO_POINT,
/**
* PyramidToMax
*/
PYRAMID_TO_MAX,
/**
* Cylinder
*/
CYLINDER,
/**
* ConeToPoint
*/
CONE_TO_POINT,
/**
* ConeToMax
*/
CONE_TO_MAX,
}
/**
* Utility class containing constants.
* Represents a preset for a type of bevel which can be applied to a shape in 3D.
* @enum {number}
*/
const BevelPresetType = {
/**
* No bevel
*/
NONE,
/**
* Angle
*/
ANGLE,
/**
* Art deco
*/
ART_DECO,
/**
* Circle
*/
CIRCLE,
/**
* Convex
*/
CONVEX,
/**
* Cool slant
*/
COOL_SLANT,
/**
* Cross
*/
CROSS,
/**
* Divot
*/
DIVOT,
/**
* Hard edge
*/
HARD_EDGE,
/**
* Relaxed inset
*/
RELAXED_INSET,
/**
* Riblet
*/
RIBLET,
/**
* Slope
*/
SLOPE,
/**
* Soft round
*/
SOFT_ROUND,
}
/**
* Utility class containing constants.
* Represents a preset for a type of bevel which can be applied to a shape in 3D.
* @enum {number}
*/
const BevelType = {
/**
* No bevel
*/
NONE,
/**
* Angle
*/
ANGLE,
/**
* Art deco
*/
ART_DECO,
/**
* Circle
*/
CIRCLE,
/**
* Convex
*/
CONVEX,
/**
* Cool slant
*/
COOL_SLANT,
/**
* Cross
*/
CROSS,
/**
* Divot
*/
DIVOT,
/**
* Hard edge
*/
HARD_EDGE,
/**
* Relaxed inset
*/
RELAXED_INSET,
/**
* Riblet
*/
RIBLET,
/**
* Slope
*/
SLOPE,
/**
* Soft round
*/
SOFT_ROUND,
}
/**
* Utility class containing constants.
* Enumerates the border line and diagonal line types.
* @enum {number}
*/
const BorderType = {
/**
* Represents bottom border line.
*/
BOTTOM_BORDER,
/**
* Represents the diagonal line from top left to right bottom.
*/
DIAGONAL_DOWN,
/**
* Represents the diagonal line from bottom left to right top.
*/
DIAGONAL_UP,
/**
* Represents left border line.
*/
LEFT_BORDER,
/**
* Represents right border line exists.
*/
RIGHT_BORDER,
/**
* Represents top border line.
*/
TOP_BORDER,
/**
* Only for dynamic style,such as conditional formatting.
*/
HORIZONTAL,
/**
* Only for dynamic style,such as conditional formatting.
*/
VERTICAL,
}
/**
* Utility class containing constants.
* Represents what the bubble size represents on a bubble chart.
* @enum {number}
*/
const BubbleSizeRepresents = {
/**
* Represents the value of Series.BubbleSizes is area of the bubble.
*/
SIZE_IS_AREA,
/**
* Represents the value of Series.BubbleSizes is width of the bubble.
*/
SIZE_IS_WIDTH,
}
/**
* Utility class containing constants.
* Represents all built-in style types.
* @enum {number}
*/
const BuiltinStyleType = {
/**
*/
TWENTY_PERCENT_ACCENT_1,
/**
*/
TWENTY_PERCENT_ACCENT_2,
/**
*/
TWENTY_PERCENT_ACCENT_3,
/**
*/
TWENTY_PERCENT_ACCENT_4,
/**
*/
TWENTY_PERCENT_ACCENT_5,
/**
*/
TWENTY_PERCENT_ACCENT_6,
/**
*/
FORTY_PERCENT_ACCENT_1,
/**
*/
FORTY_PERCENT_ACCENT_2,
/**
*/
FORTY_PERCENT_ACCENT_3,
/**
*/
FORTY_PERCENT_ACCENT_4,
/**
*/
FORTY_PERCENT_ACCENT_5,
/**
*/
FORTY_PERCENT_ACCENT_6,
/**
*/
SIXTY_PERCENT_ACCENT_1,
/**
*/
SIXTY_PERCENT_ACCENT_2,
/**
*/
SIXTY_PERCENT_ACCENT_3,
/**
*/
SIXTY_PERCENT_ACCENT_4,
/**
*/
SIXTY_PERCENT_ACCENT_5,
/**
*/
SIXTY_PERCENT_ACCENT_6,
/**
*/
ACCENT_1,
/**
*/
ACCENT_2,
/**
*/
ACCENT_3,
/**
*/
ACCENT_4,
/**
*/
ACCENT_5,
/**
*/
ACCENT_6,
/**
*/
BAD,
/**
*/
CALCULATION,
/**
*/
CHECK_CELL,
/**
*/
COMMA,
/**
*/
COMMA_1,
/**
*/
CURRENCY,
/**
*/
CURRENCY_1,
/**
*/
EXPLANATORY_TEXT,
/**
*/
GOOD,
/**
*/
HEADER_1,
/**
*/
HEADER_2,
/**
*/
HEADER_3,
/**
*/
HEADER_4,
/**
*/
HYPERLINK,
/**
*/
FOLLOWED_HYPERLINK,
/**
*/
INPUT,
/**
*/
LINKED_CELL,
/**
*/
NEUTRAL,
/**
*/
NORMAL,
/**
*/
NOTE,
/**
*/
OUTPUT,
/**
*/
PERCENT,
/**
*/
TITLE,
/**
*/
TOTAL,
/**
*/
WARNING_TEXT,
/**
*/
ROW_LEVEL,
/**
*/
COLUMN_LEVEL,
}
/**
* Utility class containing constants.
* Represents the type of the bullet.
* @enum {number}
*/
const BulletType = {
/**
* No bullet.
*/
NONE,
/**
* Character bullet.
*/
CHARACTER,
/**
* Image bullet.
*/
PICTURE,
/**
* Automatic numbered bullet.
*/
AUTO_NUMBERED,
}
/**
* Utility class containing constants.
* Represents the mode type of calculating formulas.
* Only sets for MS Excel.
* @enum {number}
*/
const CalcModeType = {
/**
*/
AUTOMATIC,
/**
*/
AUTOMATIC_EXCEPT_TABLE,
/**
*/
MANUAL,
}
/**
* Utility class containing constants.
* 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.
* @enum {number}
*/
const 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,
/**
* Rounds the calculation result according with significant digits.
*/
ROUND,
/**
* Uses decimal as operands when possible.
* Most inefficient for performance.
*/
DECIMAL,
}
/**
* Utility class containing constants.
* Represents the category axis type.
* @enum {number}
*/
const CategoryType = {
/**
* AutomaticScale
*/
AUTOMATIC_SCALE,
/**
* CategoryScale
*/
CATEGORY_SCALE,
/**
* TimeScale
*/
TIME_SCALE,
}
/**
* Utility class containing constants.
* Enumerates a cell's border type.
* @enum {number}
*/
const CellBorderType = {
/**
* Represents thin dash-dotted line.
*/
DASH_DOT,
/**
* Represents thin dash-dot-dotted line.
*/
DASH_DOT_DOT,
/**
* Represents dashed line.
*/
DASHED,
/**
* Represents dotted line.
*/
DOTTED,
/**
* Represents double line.
*/
DOUBLE,
/**
* Represents hair line.
*/
HAIR,
/**
* Represents medium dash-dotted line.
*/
MEDIUM_DASH_DOT,
/**
* Represents medium dash-dot-dotted line.
*/
MEDIUM_DASH_DOT_DOT,
/**
* Represents medium dashed line.
*/
MEDIUM_DASHED,
/**
* Represents no line.
*/
NONE,
/**
* Represents medium line.
*/
MEDIUM,
/**
* Represents slanted medium dash-dotted line.
*/
SLANTED_DASH_DOT,
/**
* Represents thick line.
*/
THICK,
/**
* Represents thin line.
*/
THIN,
}
/**
* Utility class containing constants.
* Specifies how to apply style for the value of the cell.
* @enum {number}
*/
const CellValueFormatStrategy = {
/**
* Not formatted.
*/
NONE,
/**
* Only formatted with the cell's original style.
*/
CELL_STYLE,
/**
* Formatted with the cell's displayed style.
*/
DISPLAY_STYLE,
/**
* Gets the displayed string shown in ms excel.
* The main difference from DISPLAY_STYLE 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.
*/
DISPLAY_STRING,
}
/**
* Utility class containing constants.
* Specifies a cell value type.
* @enum {number}
*/
const CellValueType = {
/**
* Cell value type is unknown.
*/
IS_UNKNOWN,
/**
* Blank cell. Corresponding value should be null.
*/
IS_NULL,
/**
* Cell value is numeric. Corresponding value must be int or double.
*/
IS_NUMERIC,
/**
* Cell value is datetime. Corresponding value must be DateTime.
*/
IS_DATE_TIME,
/**
* Cell value is string. Corresponding value must be string.
*/
IS_STRING,
/**
* Cell value is boolean. Corresponding value must be bool.
*/
IS_BOOL,
/**
* Cell contains error value. Corresponding value must be error string.
*/
IS_ERROR,
}
/**
* Utility class containing constants.
* Represents line format type of chart line.
* @enum {number}
*/
const ChartLineFormattingType = {
/**
* Represents automatic formatting type.
*/
AUTOMATIC,
/**
* Represents solid formatting type.
*/
SOLID,
/**
* Represents none formatting type.
*/
NONE,
/**
* Gradient
*/
GRADIENT,
}
/**
* Utility class containing constants.
* Represents the marker style in a line chart, scatter chart, or radar chart.
* @enum {number}
*/
const ChartMarkerType = {
/**
* Automatic markers.
*/
AUTOMATIC,
/**
* Circular markers.
*/
CIRCLE,
/**
* Long bar markers
*/
DASH,
/**
* Diamond-shaped markers.
*/
DIAMOND,
/**
* Short bar markers.
*/
DOT,
/**
* No markers.
*/
NONE,
/**
* Square markers with a plus sign.
*/
SQUARE_PLUS,
/**
* Square markers.
*/
SQUARE,
/**
* Square markers with an asterisk.
*/
SQUARE_STAR,
/**
* Triangular markers.
*/
TRIANGLE,
/**
* Square markers with an X.
*/
SQUARE_X,
/**
* Picture
*/
PICTURE,
}
/**
* Utility class containing constants.
* Represents the way the two sections of either a pie of pie chart or a bar of pie chart are split.
* @enum {number}
*/
const ChartSplitType = {
/**
* Represents the data points shall be split between the pie
* and the second chart by putting the last Split Position
* of the data points in the second chart
*/
POSITION,
/**
* Represents the data points shall be split between the pie
* and the second chart by putting the data points with
* value less than Split Position in the second chart.
*/
VALUE,
/**
* Represents the data points shall be split between the pie
* and the second chart by putting the points with
* percentage less than Split Position percent in the
* second chart.
*/
PERCENT_VALUE,
/**
* Represents the data points shall be split between the pie
* and the second chart according to the Custom Split
* values.
*/
CUSTOM,
/**
* Represents the data points shall be split using the default
* mechanism for this chart type.
* NOTE: This member is now obsolete. Instead,
* please use Series.IsAutoSplit property.
* This property will be removed 12 months later since September 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
AUTO,
}
/**
* Utility class containing constants.
* Represents the text direction type of the chart.
* @enum {number}
*/
const ChartTextDirectionType = {
/**
* Horizontal direction type.
*/
HORIZONTAL,
/**
* Vertical direction type.
*/
VERTICAL,
/**
* Rotate 90 angle.
*/
ROTATE_90,
/**
* Rotate 270 angle.
*/
ROTATE_270,
/**
* Stacked text.
*/
STACKED,
}
/**
* Utility class containing constants.
* Enumerates all chart types used in Excel.
* @enum {number}
*/
const ChartType = {
/**
* Represents Area Chart.
*/
AREA,
/**
* Represents Stacked Area Chart.
*/
AREA_STACKED,
/**
* Represents 100% Stacked Area Chart.
*/
AREA_100_PERCENT_STACKED,
/**
* Represents 3D Area Chart.
*/
AREA_3_D,
/**
* Represents 3D Stacked Area Chart.
*/
AREA_3_D_STACKED,
/**
* Represents 3D 100% Stacked Area Chart.
*/
AREA_3_D_100_PERCENT_STACKED,
/**
* Represents Bar Chart: Clustered Bar Chart.
*/
BAR,
/**
* Represents Stacked Bar Chart.
*/
BAR_STACKED,
/**
* Represents 100% Stacked Bar Chart.
*/
BAR_100_PERCENT_STACKED,
/**
* Represents 3D Clustered Bar Chart.
*/
BAR_3_D_CLUSTERED,
/**
* Represents 3D Stacked Bar Chart.
*/
BAR_3_D_STACKED,
/**
* Represents 3D 100% Stacked Bar Chart.
*/
BAR_3_D_100_PERCENT_STACKED,
/**
* Represents Bubble Chart.
*/
BUBBLE,
/**
* Represents 3D Bubble Chart.
*/
BUBBLE_3_D,
/**
* Represents Column Chart: Clustered Column Chart.
*/
COLUMN,
/**
* Represents Stacked Column Chart.
*/
COLUMN_STACKED,
/**
* Represents 100% Stacked Column Chart.
*/
COLUMN_100_PERCENT_STACKED,
/**
* Represents 3D Column Chart.
*/
COLUMN_3_D,
/**
* Represents 3D Clustered Column Chart.
*/
COLUMN_3_D_CLUSTERED,
/**
* Represents 3D Stacked Column Chart.
*/
COLUMN_3_D_STACKED,
/**
* Represents 3D 100% Stacked Column Chart.
*/
COLUMN_3_D_100_PERCENT_STACKED,
/**
* Represents Cone Chart.
*/
CONE,
/**
* Represents Stacked Cone Chart.
*/
CONE_STACKED,
/**
* Represents 100% Stacked Cone Chart.
*/
CONE_100_PERCENT_STACKED,
/**
* Represents Conical Bar Chart.
*/
CONICAL_BAR,
/**
* Represents Stacked Conical Bar Chart.
*/
CONICAL_BAR_STACKED,
/**
* Represents 100% Stacked Conical Bar Chart.
*/
CONICAL_BAR_100_PERCENT_STACKED,
/**
* Represents 3D Conical Column Chart.
*/
CONICAL_COLUMN_3_D,
/**
* Represents Cylinder Chart.
*/
CYLINDER,
/**
* Represents Stacked Cylinder Chart.
*/
CYLINDER_STACKED,
/**
* Represents 100% Stacked Cylinder Chart.
*/
CYLINDER_100_PERCENT_STACKED,
/**
* Represents Cylindrical Bar Chart.
*/
CYLINDRICAL_BAR,
/**
* Represents Stacked Cylindrical Bar Chart.
*/
CYLINDRICAL_BAR_STACKED,
/**
* Represents 100% Stacked Cylindrical Bar Chart.
*/
CYLINDRICAL_BAR_100_PERCENT_STACKED,
/**
* Represents 3D Cylindrical Column Chart.
*/
CYLINDRICAL_COLUMN_3_D,
/**
* Represents Doughnut Chart.
*/
DOUGHNUT,
/**
* Represents Exploded Doughnut Chart.
*/
DOUGHNUT_EXPLODED,
/**
* Represents Line Chart.
*/
LINE,
/**
* Represents Stacked Line Chart.
*/
LINE_STACKED,
/**
* Represents 100% Stacked Line Chart.
*/
LINE_100_PERCENT_STACKED,
/**
* Represents Line Chart with data markers.
*/
LINE_WITH_DATA_MARKERS,
/**
* Represents Stacked Line Chart with data markers.
*/
LINE_STACKED_WITH_DATA_MARKERS,
/**
* Represents 100% Stacked Line Chart with data markers.
*/
LINE_100_PERCENT_STACKED_WITH_DATA_MARKERS,
/**
* Represents 3D Line Chart.
*/
LINE_3_D,
/**
* Represents Pie Chart.
*/
PIE,
/**
* Represents 3D Pie Chart.
*/
PIE_3_D,
/**
* Represents Pie of Pie Chart.
*/
PIE_PIE,
/**
* Represents Exploded Pie Chart.
*/
PIE_EXPLODED,
/**
* Represents 3D Exploded Pie Chart.
*/
PIE_3_D_EXPLODED,
/**
* Represents Bar of Pie Chart.
*/
PIE_BAR,
/**
* Represents Pyramid Chart.
*/
PYRAMID,
/**
* Represents Stacked Pyramid Chart.
*/
PYRAMID_STACKED,
/**
* Represents 100% Stacked Pyramid Chart.
*/
PYRAMID_100_PERCENT_STACKED,
/**
* Represents Pyramid Bar Chart.
*/
PYRAMID_BAR,
/**
* Represents Stacked Pyramid Bar Chart.
*/
PYRAMID_BAR_STACKED,
/**
* Represents 100% Stacked Pyramid Bar Chart.
*/
PYRAMID_BAR_100_PERCENT_STACKED,
/**
* Represents 3D Pyramid Column Chart.
*/
PYRAMID_COLUMN_3_D,
/**
* Represents Radar Chart.
*/
RADAR,
/**
* Represents Radar Chart with data markers.
*/
RADAR_WITH_DATA_MARKERS,
/**
* Represents Filled Radar Chart.
*/
RADAR_FILLED,
/**
* Represents Scatter Chart.
*/
SCATTER,
/**
* Represents Scatter Chart connected by curves, with data markers.
*/
SCATTER_CONNECTED_BY_CURVES_WITH_DATA_MARKER,
/**
* Represents Scatter Chart connected by curves, without data markers.
*/
SCATTER_CONNECTED_BY_CURVES_WITHOUT_DATA_MARKER,
/**
* Represents Scatter Chart connected by lines, with data markers.
*/
SCATTER_CONNECTED_BY_LINES_WITH_DATA_MARKER,
/**
* Represents Scatter Chart connected by lines, without data markers.
*/
SCATTER_CONNECTED_BY_LINES_WITHOUT_DATA_MARKER,
/**
* Represents High-Low-Close Stock Chart.
*/
STOCK_HIGH_LOW_CLOSE,
/**
* Represents Open-High-Low-Close Stock Chart.
*/
STOCK_OPEN_HIGH_LOW_CLOSE,
/**
* Represents Volume-High-Low-Close Stock Chart.
*/
STOCK_VOLUME_HIGH_LOW_CLOSE,
/**
* Represents Volume-Open-High-Low-Close Stock Chart.
*/
STOCK_VOLUME_OPEN_HIGH_LOW_CLOSE,
/**
* Represents Surface Chart: 3D Surface Chart.
*/
SURFACE_3_D,
/**
* Represents Wireframe 3D Surface Chart.
*/
SURFACE_WIREFRAME_3_D,
/**
* Represents Contour Chart.
*/
SURFACE_CONTOUR,
/**
* Represents Wireframe Contour Chart.
*/
SURFACE_CONTOUR_WIREFRAME,
/**
* The series is laid out as box and whisker.
*/
BOX_WHISKER,
/**
* The series is laid out as a funnel.
*/
FUNNEL,
/**
* The series is laid out as pareto lines.
*/
PARETO_LINE,
/**
* The series is laid out as a sunburst.
*/
SUNBURST,
/**
* The series is laid out as a treemap.
*/
TREEMAP,
/**
* The series is laid out as a waterfall.
*/
WATERFALL,
/**
* The series is laid out as a histogram.
*/
HISTOGRAM,
/**
* The series is laid out as a region map.
*/
MAP,
/**
* The series is laid out as a radial historgram. It is used only for rendering
*/
RADIAL_HISTOGRAM,
}
/**
* Utility class containing constants.
* Represents the check value type of the check box.
* @enum {number}
*/
const CheckValueType = {
/**
* UnChecked
*/
UN_CHECKED,
/**
* Checked
*/
CHECKED,
/**
* Mixed
*/
MIXED,
}
/**
* Utility class containing constants.
* Enumerates Bit Depth Type for tiff image.
* @enum {number}
*/
const ColorDepth = {
/**
* Default value, not set value.
*/
DEFAULT,
/**
* 1 bit per pixel
*/
FORMAT_1_BPP,
/**
* 4 bits per pixel
*/
FORMAT_4_BPP,
/**
* 8 bits per pixel
*/
FORMAT_8_BPP,
/**
* 24 bits per pixel
*/
FORMAT_24_BPP,
/**
* 32 bits per pixel
*/
FORMAT_32_BPP,
}
/**
* Utility class containing constants.
* Represents all color type
* @enum {number}
*/
const ColorType = {
/**
* Automatic color.
*/
AUTOMATIC,
/**
* It's automatic color,but the displayed color depends the setting of the OS System.
* Not supported.
*/
AUTOMATIC_INDEX,
/**
* The RGB color.
*/
RGB,
/**
* The color index in the color palette.
*/
INDEXED_COLOR,
/**
* The theme color.
*/
THEME,
}
/**
* Utility class containing constants.
* Represents comment title type while rendering when comment is set to display at end of sheet.
* @enum {number}
*/
const CommentTitleType = {
/**
* Represents comment title cell.
*/
CELL,
/**
* Represents comment title comment.
*/
COMMENT,
/**
* Represents comment title note.
*/
NOTE,
/**
* Represents comment title reply.
*/
REPLY,
}
/**
* Utility class containing constants.
* Represents consolidation function.
* @enum {number}
*/
const ConsolidationFunction = {
/**
* Represents Sum function.
*/
SUM,
/**
* Represents Count function.
*/
COUNT,
/**
* Represents Average function.
*/
AVERAGE,
/**
* Represents Max function.
*/
MAX,
/**
* Represents Min function.
*/
MIN,
/**
* Represents Product function.
*/
PRODUCT,
/**
* Represents Count Nums function.
*/
COUNT_NUMS,
/**
* Represents StdDev function.
*/
STD_DEV,
/**
* Represents StdDevp function.
*/
STD_DEVP,
/**
* Represents Var function.
*/
VAR,
/**
* Represents Varp function.
*/
VARP,
/**
* Represents Distinct Count function.
* Only valid for PivotTable with Data Module created since by 2013.
*/
DISTINCT_COUNT,
}
/**
* Utility class containing constants.
* Represents the border type of the ActiveX control.
* @enum {number}
*/
const ControlBorderType = {
/**
* No border.
*/
NONE,
/**
* The single line.
*/
SINGLE,
}
/**
* Utility class containing constants.
* Represents the position of the Caption relative to the control.
* @enum {number}
*/
const ControlCaptionAlignmentType = {
/**
* The left of the control.
*/
LEFT,
/**
* The right of the control.
*/
RIGHT,
}
/**
* Utility class containing constants.
* Represents the visual appearance of the list in a ListBox or ComboBox.
* @enum {number}
*/
const ControlListStyle = {
/**
* Displays a list in which the background of an item is highlighted when it is selected.
*/
PLAIN,
/**
* Displays a list in which an option button or a checkbox next to each entry displays the selection state of that item.
*/
OPTION,
}
/**
* Utility class containing constants.
* Represents how a ListBox or ComboBox searches its list as the user types.
* @enum {number}
*/
const 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.
*/
FIRST_LETTER,
/**
* As each character is typed, the control searches for an entry matching all characters entered.
*/
COMPLETE,
/**
* The list will not be searched when characters are typed.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the type of icon displayed as the mouse pointer for the control.
* @enum {number}
*/
const ControlMousePointerType = {
/**
* Standard pointer.
*/
DEFAULT,
/**
* Arrow.
*/
ARROW,
/**
* Cross-hair pointer.
*/
CROSS,
/**
* I-beam.
*/
I_BEAM,
/**
* Double arrow pointing northeast and southwest.
*/
SIZE_NESW,
/**
* Double arrow pointing north and south.
*/
SIZE_NS,
/**
* Double arrow pointing northwest and southeast.
*/
SIZE_NWSE,
/**
* Double arrow pointing west and east.
*/
SIZE_WE,
/**
* Up arrow.
*/
UP_ARROW,
/**
* Hourglass.
*/
HOUR_GLASS,
/**
* "Not” symbol (circle with a diagonal line) on top of the object being dragged.
*/
NO_DROP,
/**
* Arrow with an hourglass.
*/
APP_STARTING,
/**
* Arrow with a question mark.
*/
HELP,
/**
* "Size-all” cursor (arrows pointing north, south, east, and west).
*/
SIZE_ALL,
/**
* Uses the icon specified by the MouseIcon property.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the alignment of the picture inside the Form or Image.
* @enum {number}
*/
const ControlPictureAlignmentType = {
/**
* The top left corner.
*/
TOP_LEFT,
/**
* The top right corner.
*/
TOP_RIGHT,
/**
* The center.
*/
CENTER,
/**
* The bottom left corner.
*/
BOTTOM_LEFT,
/**
* The bottom right corner.
*/
BOTTOM_RIGHT,
}
/**
* Utility class containing constants.
* Represents the location of the control's picture relative to its caption.
* @enum {number}
*/
const ControlPicturePositionType = {
/**
* The picture appears to the left of the caption.
* The caption is aligned with the top of the picture.
*/
LEFT_TOP,
/**
* The picture appears to the left of the caption.
* The caption is centered relative to the picture.
*/
LEFT_CENTER,
/**
* The picture appears to the left of the caption.
* The caption is aligned with the bottom of the picture.
*/
LEFT_BOTTOM,
/**
* The picture appears to the right of the caption.
* The caption is aligned with the top of the picture.
*/
RIGHT_TOP,
/**
* The picture appears to the right of the caption.
* The caption is centered relative to the picture.
*/
RIGHT_CENTER,
/**
* The picture appears to the right of the caption.
* The caption is aligned with the bottom of the picture.
*/
RIGHT_BOTTOM,
/**
* The picture appears above the caption.
* The caption is aligned with the left edge of the picture.
*/
ABOVE_LEFT,
/**
* The picture appears above the caption.
* The caption is centered below the picture.
*/
ABOVE_CENTER,
/**
* The picture appears above the caption.
* The caption is aligned with the right edge of the picture.
*/
ABOVE_RIGHT,
/**
* The picture appears below the caption.
* The caption is aligned with the left edge of the picture.
*/
BELOW_LEFT,
/**
* The picture appears below the caption.
* The caption is centered above the picture.
*/
BELOW_CENTER,
/**
* The picture appears below the caption.
* The caption is aligned with the right edge of the picture.
*/
BELOW_RIGHT,
/**
* The picture appears in the center of the control.
* The caption is centered horizontally and vertically on top of the picture.
*/
CENTER,
}
/**
* Utility class containing constants.
* Represents how to display the picture.
* @enum {number}
*/
const ControlPictureSizeMode = {
/**
* Crops any part of the picture that is larger than the control's boundaries.
*/
CLIP,
/**
* Stretches the picture to fill the control's area.
* This setting distorts the picture in either the horizontal or vertical direction.
*/
STRETCH,
/**
* Enlarges the picture, but does not distort the picture in either the horizontal or vertical direction.
*/
ZOOM,
}
/**
* Utility class containing constants.
* Represents the type of scroll bar.
* @enum {number}
*/
const ControlScrollBarType = {
/**
* Displays no scroll bars.
*/
NONE,
/**
* Displays a horizontal scroll bar.
*/
HORIZONTAL,
/**
* Displays a vertical scroll bar.
*/
BARS_VERTICAL,
/**
* Displays both a horizontal and a vertical scroll bar.
*/
BARS_BOTH,
}
/**
* Utility class containing constants.
* Represents type of scroll orientation
* @enum {number}
*/
const ControlScrollOrientation = {
/**
* Control is rendered horizontally when the control's width is greater than its height.
* Control is rendered vertically otherwise.
*/
AUTO,
/**
* Control is rendered vertically.
*/
VERTICAL,
/**
* Control is rendered horizontally.
*/
HORIZONTAL,
}
/**
* Utility class containing constants.
* Represents the type of special effect.
* @enum {number}
*/
const ControlSpecialEffectType = {
/**
* Flat
*/
FLAT,
/**
* Raised
*/
RAISED,
/**
* Sunken
*/
SUNKEN,
/**
* Etched
*/
ETCHED,
/**
* Bump
*/
BUMP,
}
/**
* Utility class containing constants.
* Represents all type of ActiveX control.
* @enum {number}
*/
const ControlType = {
/**
* Button
*/
COMMAND_BUTTON,
/**
* ComboBox
*/
COMBO_BOX,
/**
* CheckBox
*/
CHECK_BOX,
/**
* ListBox
*/
LIST_BOX,
/**
* TextBox
*/
TEXT_BOX,
/**
* Spinner
*/
SPIN_BUTTON,
/**
* RadioButton
*/
RADIO_BUTTON,
/**
* Label
*/
LABEL,
/**
* Image
*/
IMAGE,
/**
* ToggleButton
*/
TOGGLE_BUTTON,
/**
* ScrollBar
*/
SCROLL_BAR,
/**
* ScrollBar
* Unsupported.
*/
BAR_CODE,
/**
* Unknown
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Represents type of copying format when inserting rows.
* @enum {number}
*/
const CopyFormatType = {
/**
* Formats same as above row.
*/
SAME_AS_ABOVE,
/**
* Formats same as below row.
*/
SAME_AS_BELOW,
/**
* Clears formatting.
*/
CLEAR,
}
/**
* Utility class containing constants.
* Represents Excel country identifiers.
* @enum {number}
*/
const CountryCode = {
/**
*/
DEFAULT,
/**
* United States
*/
USA,
/**
* Canada
*/
CANADA,
/**
* Latin America, except Brazil
*/
LATIN_AMERIC,
/**
* Russia
*/
RUSSIA,
/**
* Egypt
*/
EGYPT,
/**
* Greece
*/
GREECE,
/**
* Netherlands
*/
NETHERLANDS,
/**
* Belgium
*/
BELGIUM,
/**
* France
*/
FRANCE,
/**
* Spain
*/
SPAIN,
/**
* Hungary
*/
HUNGARY,
/**
* Italy
*/
ITALY,
/**
* Switzerland
*/
SWITZERLAND,
/**
* Austria
*/
AUSTRIA,
/**
* United Kingdom
*/
UNITED_KINGDOM,
/**
* Denmark
*/
DENMARK,
/**
* Sweden
*/
SWEDEN,
/**
* Norway
*/
NORWAY,
/**
* Poland
*/
POLAND,
/**
* Germany
*/
GERMANY,
/**
* Mexico
*/
MEXICO,
/**
* Brazil
*/
BRAZIL,
/**
* Australia
*/
AUSTRALIA,
/**
* New Zealand
*/
NEW_ZEALAND,
/**
* Thailand
*/
THAILAND,
/**
* Japan
*/
JAPAN,
/**
* SouthKorea
*/
SOUTH_KOREA,
/**
* Viet Nam
*/
VIET_NAM,
/**
* People's Republic of China
*/
CHINA,
/**
* Turkey
*/
TURKEY,
/**
* India
*/
INDIA,
/**
* Algeria
*/
ALGERIA,
/**
* Morocco
*/
MOROCCO,
/**
* Libya
*/
LIBYA,
/**
* Portugal
*/
PORTUGAL,
/**
* Iceland
*/
ICELAND,
/**
* Finland
*/
FINLAND,
/**
* Czech Republic
*/
CZECH,
/**
* Taiwan
*/
TAIWAN,
/**
* Lebanon
*/
LEBANON,
/**
* Jordan
*/
JORDAN,
/**
* Syria
*/
SYRIA,
/**
* Iraq
*/
IRAQ,
/**
* Kuwait
*/
KUWAIT,
/**
* Saudi Arabia
*/
SAUDI,
/**
* United Arab Emirates
*/
UNITED_ARAB_EMIRATES,
/**
* Israel
*/
ISRAEL,
/**
* Qatar
*/
QATAR,
/**
* Iran
*/
IRAN,
}
/**
* Utility class containing constants.
* Specifies Credentials method used for server access.
* @enum {number}
*/
const CredentialsMethodType = {
/**
* Integrated Authentication
*/
INTEGRATED,
/**
* No Credentials
*/
NONE,
/**
* Prompt Credentials
*/
PROMPT,
/**
* Stored Credentials
*/
STORED,
}
/**
* Utility class containing constants.
* Represents the axis cross type.
* @enum {number}
*/
const CrossType = {
/**
* Microsoft Excel sets the axis crossing point.
*/
AUTOMATIC,
/**
* The axis crosses at the maximum value.
*/
MAXIMUM,
/**
* The axis crosses at the minimum value.
*/
MINIMUM,
/**
* The axis crosses at the custom value.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Specifies the axis position for a range of cells with conditional formatting as data bars.
* @enum {number}
*/
const 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,
/**
* 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,
/**
* No axis is displayed, and both positive and negative values are displayed in the left-to-right direction.
*/
NONE,
}
/**
* Utility class containing constants.
* Specifies the border type of a data bar.
* @enum {number}
*/
const DataBarBorderType = {
/**
* The data bar has no border.
*/
NONE,
/**
* The data bar has a solid border.
*/
SOLID,
}
/**
* Utility class containing constants.
* Specifies how a data bar is filled with color.
* @enum {number}
*/
const DataBarFillType = {
/**
* The data bar is filled with solid color.
*/
SOLID,
/**
* The data bar is filled with a color gradient.
*/
GRADIENT,
}
/**
* Utility class containing constants.
* Specifies whether to use the same border and fill color as positive data bars.
* @enum {number}
*/
const 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,
/**
* Use the same color as positive data bars.
*/
SAME_AS_POSITIVE,
}
/**
* Utility class containing constants.
* Specifies the preset shape geometry that is to be used for a chart.
* @enum {number}
*/
const DataLabelShapeType = {
/**
* Represents the rectangle shape.
*/
RECT,
/**
* Represents the round rectangle shape.
*/
ROUND_RECT,
/**
* Represents the ellipse shape.
*/
ELLIPSE,
/**
* Represents the right arrow callout shape.
*/
RIGHT_ARROW_CALLOUT,
/**
* Represents the down arrow callout shape.
*/
DOWN_ARROW_CALLOUT,
/**
* Represents the left arrow callout shape.
*/
LEFT_ARROW_CALLOUT,
/**
* Represents the up arrow callout shape.
*/
UP_ARROW_CALLOUT,
/**
* Represents the wedge rectangle callout shape.
*/
WEDGE_RECT_CALLOUT,
/**
* Represents the wedge round rectangle callout shape.
*/
WEDGE_ROUND_RECT_CALLOUT,
/**
* Represents the wedge ellipse callout shape.
*/
WEDGE_ELLIPSE_CALLOUT,
/**
* Represents the line callout shape.
*/
LINE_CALLOUT,
/**
* Represents the bent line callout shape.
*/
BENT_LINE_CALLOUT,
/**
* Represents the line with accent bar callout shape.
*/
LINE_WITH_ACCENT_BAR_CALLOUT,
/**
* Represents the bent line with accent bar callout shape.
*/
BENT_LINE_WITH_ACCENT_BAR_CALLOUT,
/**
* This type is only used for special file processing
*/
LINE,
}
/**
* Utility class containing constants.
* Represents the separator type of DataLabels.
* @enum {number}
*/
const DataLabelsSeparatorType = {
/**
* Represents automatic separator
*/
AUTO,
/**
* Represents space(" ")
*/
SPACE,
/**
* Represents comma(",")
*/
COMMA,
/**
* Represents semicolon(";")
*/
SEMICOLON,
/**
* Represents period(".")
*/
PERIOD,
/**
* Represents newline("\n")
*/
NEW_LINE,
/**
* Represents custom separator
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Specifies how to group dateTime values.
* @enum {number}
*/
const DateTimeGroupingType = {
/**
* Group by day.
*/
DAY,
/**
* Group by hour.
*/
HOUR,
/**
* Group by Minute.
*/
MINUTE,
/**
* Group by Month.
*/
MONTH,
/**
* Group by Second.
*/
SECOND,
/**
* Group by Year.
*/
YEAR,
}
/**
* Utility class containing constants.
* Represents the default edit language.
* @enum {number}
*/
const DefaultEditLanguage = {
/**
* Represents auto detecting edit language according to the text itself.
*/
AUTO,
/**
* Represents English language.
*/
ENGLISH,
/**
* Represents Chinese, Japanese, Korean language.
*/
CJK,
}
/**
* Utility class containing constants.
* Represents the directory type of the file name.
* @enum {number}
*/
const 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,
/**
* Indicates that the source workbook is on the same drive as the dependent workbook (the drive letter is omitted)
*/
SAME_VOLUME,
/**
* Indicates that the source workbook is in a subdirectory of the current directory.
*/
DOWN_DIRECTORY,
/**
* Indicates that the source workbook is in the parent directory of the current directory.
*/
UP_DIRECTORY,
}
/**
* Utility class containing constants.
* Represents whether and how to show objects in the workbook.
* @enum {number}
*/
const DisplayDrawingObjects = {
/**
* Show all objects
*/
DISPLAY_SHAPES,
/**
* Show placeholders
*/
PLACEHOLDERS,
/**
* Hide all shapes.
*/
HIDE,
}
/**
* Utility class containing constants.
* Represents the type of display unit of chart's axis.
* @enum {number}
*/
const DisplayUnitType = {
/**
* Display unit is None.
*/
NONE,
/**
* Specifies the values on the chart shall be divided by 100.
*/
HUNDREDS,
/**
* Specifies the values on the chart shall be divided by 1,000.
*/
THOUSANDS,
/**
* Specifies the values on the chart shall be divided by 10,000.
*/
TEN_THOUSANDS,
/**
* Specifies the values on the chart shall be divided by 100,000.
*/
HUNDRED_THOUSANDS,
/**
* Specifies the values on the chart shall be divided by 1,000,000.
*/
MILLIONS,
/**
* Specifies the values on the chart shall be divided by 10,000,000.
*/
TEN_MILLIONS,
/**
* Specifies the values on the chart shall be divided by 100,000,000.
*/
HUNDRED_MILLIONS,
/**
* Specifies the values on the chart shall be divided by 1,000,000,000.
*/
BILLIONS,
/**
* Specifies the values on the chart shall be divided by 1,000,000,000,000.
*/
TRILLIONS,
/**
* The values on the chart shall be divided by 0.01.
*/
PERCENTAGE,
/**
* specifies a custom value for the display unit.
* NOTE: This member is now obsolete. Instead,
* please use DisplayUnitType.Custom.
* This property will be removed 12 months later since January 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
CUST,
/**
* specifies a custom value for the display unit.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the symbol displayed on the drop button.
* @enum {number}
*/
const DropButtonStyle = {
/**
* Displays a button with no symbol.
*/
PLAIN,
/**
* Displays a button with a down arrow.
*/
ARROW,
/**
* Displays a button with an ellipsis (...).
*/
ELLIPSIS,
/**
* Displays a button with a horizontal line like an underscore character.
*/
REDUCE,
}
/**
* Utility class containing constants.
* Dynamic filter type.
* @enum {number}
*/
const DynamicFilterType = {
/**
* Shows values that are above average.
*/
ABOVE_AVERAGE,
/**
* Shows values that are below average.
*/
BELOW_AVERAGE,
/**
* Shows last month's dates.
*/
LAST_MONTH,
/**
* Shows last quarter's dates.
*/
LAST_QUARTER,
/**
* Shows last week's dates.
*/
LAST_WEEK,
/**
* Shows last year's dates.
*/
LAST_YEAR,
/**
* Shows the dates that are in January, regardless of year.
*/
JANUARY,
/**
* Shows the dates that are in October, regardless of year.
*/
OCTOBER,
/**
* Shows the dates that are in November, regardless of year.
*/
NOVEMBER,
/**
* Shows the dates that are in December, regardless of year.
*/
DECEMBER,
/**
* Shows the dates that are in February, regardless of year.
*/
FEBRUARY,
/**
* Shows the dates that are in March, regardless of year.
*/
MARCH,
/**
* Shows the dates that are in April, regardless of year.
*/
APRIL,
/**
* Shows the dates that are in May, regardless of year.
*/
MAY,
/**
* Shows the dates that are in June, regardless of year.
*/
JUNE,
/**
* Shows the dates that are in July, regardless of year.
*/
JULY,
/**
* Shows the dates that are in August, regardless of year.
*/
AUGUST,
/**
* Shows the dates that are in September, regardless of year.
*/
SEPTEMBER,
/**
* Shows next month's dates.
*/
NEXT_MONTH,
/**
* Shows next quarter's dates.
*/
NEXT_QUARTER,
/**
* Shows next week's dates.
*/
NEXT_WEEK,
/**
* Shows next year's dates.
*/
NEXT_YEAR,
/**
* None.
*/
NONE,
/**
* Shows the dates that are in the 1st quarter, regardless of year.
*/
QUARTER_1,
/**
* Shows the dates that are in the 2nd quarter, regardless of year.
*/
QUARTER_2,
/**
* Shows the dates that are in the 3rd quarter, regardless of year.
*/
QUARTER_3,
/**
* Shows the dates that are in the 4th quarter, regardless of year.
*/
QUARTER_4,
/**
* Shows this month's dates.
*/
THIS_MONTH,
/**
* Shows this quarter's dates.
*/
THIS_QUARTER,
/**
* Shows this week's dates.
*/
THIS_WEEK,
/**
* Shows this year's dates.
*/
THIS_YEAR,
/**
* Shows today's dates.
*/
TODAY,
/**
* Shows tomorrow's dates.
*/
TOMORROW,
/**
* Shows the dates between the beginning of the year and today, inclusive.
*/
YEAR_TO_DATE,
/**
* Shows yesterday's dates.
*/
YESTERDAY,
}
/**
* Utility class containing constants.
* Setting for rendering Emf metafile.
* @enum {number}
*/
const EmfRenderSetting = {
/**
* Only rendering Emf records.
*/
EMF_ONLY,
/**
* Prefer rendering EmfPlus records.
*/
EMF_PLUS_PREFER,
}
/**
* Utility class containing constants.
* Encryption Type.
* Only used by excel2003.
* We will encrypt 2007/2010 workbook using SHA AES the same as Excel does, and this EncryptionType will be ignored.
* @enum {number}
*/
const EncryptionType = {
/**
*/
XOR,
/**
* Office 97/2000 compatible.
*/
COMPATIBLE,
/**
*/
ENHANCED_CRYPTOGRAPHIC_PROVIDER_V_1,
/**
*/
STRONG_CRYPTOGRAPHIC_PROVIDER,
}
/**
* Utility class containing constants.
* Specifies the position of a particular subobject within its parent
* @enum {number}
*/
const EquationCharacterPositionType = {
/**
* At the top of the parent object
*/
TOP,
/**
* At the bottom of the parent object
*/
BOTTOM,
}
/**
* Utility class containing constants.
* Type of combining characters.
* @enum {number}
*/
const EquationCombiningCharacterType = {
/**
* Use unknown type when not found in existing type.
*/
UNKNOWN,
/**
* "̇" Unicode: u0307
* Combining Dot Above
*/
DOT_ABOVE,
/**
* "̈" Unicode: u0308
* Combining Diaeresis
*/
DIAERESIS,
/**
* "⃛" Unicode: u20db
* Combining Three Dots Above
*/
THREE_DOTS_ABOVE,
/**
* "̂" Unicode: u0302
* Combining Circumflex Accent
*/
CIRCUMFLEX_ACCENT,
/**
* "̌" Unicode: u030c
* Combining Caron
*/
CARON,
/**
* "́" Unicode: u0301
* Combining Acute Accent
*/
ACUTE_ACCENT,
/**
* "̀" Unicode: u0300
* Combining Grave Accent
*/
GRAVE_ACCENT,
/**
* "̆" Unicode: u0306
* Combining Combining Breve
*/
BREVE,
/**
* "̃" Unicode: u0303
* Combining Tilde
*/
TILDE,
/**
* "̅" Unicode: u0305
* Combining Overline
*/
OVERLINE,
/**
* "̿" Unicode: u033f
* Combining Double Overline
*/
DOUBLE_OVERLINE,
/**
* "⏞" Unicode: u23de
* Combining Top Curly Bracket
*/
TOP_CURLY_BRACKET,
/**
* "⏟" Unicode: u23df
* Combining Bottom Curly Bracket
*/
BOTTOM_CURLY_BRACKET,
/**
* "⃖" Unicode: u20d6
* Combining Left Arrow Above
*/
LEFT_ARROW_ABOVE,
/**
* "⃗" Unicode: u20d7
* Combining Right Arrow Above
*/
RIGHT_ARROW_ABOVE,
/**
* "⃡" Unicode: u20e1
* Combining Left Right Arrow Above
*/
LEFT_RIGHT_ARROW_ABOVE,
/**
* "⃐" Unicode: u20d0
* Combining Left Harpoon Above
*/
LEFT_HARPOON_ABOVE,
/**
* "⃑" Unicode: u20d1
* Combining Right Harpoon Above
*/
RIGHT_HARPOON_ABOVE,
/**
* "←" Unicode: u2190
* Leftwards Arrow
*/
LEFTWARDS_ARROW,
/**
* "→" Unicode: u2192
* Rightwards Arrow
*/
RIGHTWARDS_ARROW,
/**
* "↔" Unicode: u2194
* Left Right Arrow
*/
LEFT_RIGHT_ARROW,
/**
* "⇐" Unicode: u21d0
* Leftwards Double Arrow
*/
LEFTWARDS_DOUBLE_ARROW,
/**
* "⇒" Unicode: u21d2
* Rightwards Double Arrow
*/
RIGHTWARDS_DOUBLE_ARROW,
/**
* "⇔" Unicode: u21d4
* Left Right Double Arrow
*/
LEFT_RIGHT_DOUBLE_ARROW,
}
/**
* Utility class containing constants.
* This specifies the shape of delimiters in the delimiter object.
* @enum {number}
*/
const EquationDelimiterShapeType = {
/**
* The divider is centered around the entire height of its content.
*/
CENTERED,
/**
* The divider is altered to exactly match their contents' height.
*/
MATCH,
}
/**
* Utility class containing constants.
* This specifies the display style of the fraction bar.
* @enum {number}
*/
const EquationFractionType = {
/**
* This specifies that the numerator is above and the denominator below is separated by a bar in the middle.
*/
BAR,
/**
* This specifies that the numerator is above and the denominator below is not separated by a bar in the middle.
*/
NO_BAR,
/**
* This specifies that the numerator is on the left and the denominator is on the right, separated by a '/' in between.
*/
LINEAR,
/**
* This specifies that the numerator is on the upper left and the denominator is on the lower right, separated by a "/".
*/
SKEWED,
}
/**
* Utility class containing constants.
* This specifies the default horizontal justification of equations in the document.
* @enum {number}
*/
const EquationHorizontalJustificationType = {
/**
* Centered
*/
CENTER,
/**
* Centered as Group
*/
CENTER_GROUP,
/**
* Left Justified
*/
LEFT,
/**
* Right Justified
*/
RIGHT,
}
/**
* Utility class containing constants.
* Specifies the limit location on an operator.
* @enum {number}
*/
const EquationLimitLocationType = {
/**
* Specifies that the limit is centered above or below the operator.
*/
UND_OVR,
/**
* Specifies that the limit is on the right side of the operator.
*/
SUB_SUP,
}
/**
* Utility class containing constants.
* Mathematical Operators Type
* @enum {number}
*/
const EquationMathematicalOperatorType = {
/**
* Use unknown type when not found in existing type.
*/
UNKNOWN,
/**
* "∀" Unicode:\u2200
*/
FOR_ALL,
/**
* "∁" Unicode:\u2201
*/
COMPLEMENT,
/**
* "∂" Unicode:\u2202
*/
PARTIAL_DIFFERENTIAL,
/**
* "∃" Unicode:\u2203
*/
EXISTS,
/**
* "∄" Unicode:\u2204
*/
NOT_EXISTS,
/**
* "∅" Unicode:\u2205
*/
EMPTY_SET,
/**
* "∆" Unicode:\u2206
*/
INCREMENT,
/**
* "∇" Unicode:\u2207
*/
NABLA,
/**
* "∈" Unicode:\u2208
*/
ELEMENT_OF,
/**
* "∉" Unicode:\u2209
*/
NOT_AN_ELEMENT_OF,
/**
* "∊" Unicode:\u220a
*/
SMALL_ELEMENT_OF,
/**
* "∋" Unicode:\u220b
*/
CONTAIN,
/**
* "∌" Unicode:\u220c
*/
NOT_CONTAIN,
/**
* "∍" Unicode:\u220d
*/
SMALL_CONTAIN,
/**
* "∎" Unicode:\u220e
*/
END_OF_PROOF,
/**
* "∏" Unicode:\u220f
*/
NARY_PRODUCT,
/**
* "∐" Unicode:\u2210
*/
NARY_COPRODUCT,
/**
* "∑" Unicode:\u2211
*/
NARY_SUMMATION,
/**
* "∧" Unicode:\u2227
*/
LOGICAL_AND,
/**
* "∨" Unicode:\u2228
*/
LOGICAL_OR,
/**
* "∩" Unicode:\u2229
*/
INTERSECTION,
/**
* "∪" Unicode:\u222a
*/
UNION,
/**
* "∫" Unicode:\u222b
*/
INTEGRAL,
/**
* "∬" Unicode:\u222c
*/
DOUBLE_INTEGRAL,
/**
* "∭" Unicode:\u222d
*/
TRIPLE_INTEGRAL,
/**
* "∮" Unicode:\u222e
*/
CONTOUR_INTEGRAL,
/**
* "∯" Unicode:\u222f
*/
SURFACE_INTEGRAL,
/**
* "∰" Unicode:\u2230
*/
VOLUME_INTEGRAL,
/**
* "∱" Unicode:\u2231
*/
CLOCKWISE,
/**
* "∲" Unicode:\u2232
*/
CLOCKWISE_CONTOUR_INTEGRAL,
/**
* "∳" Unicode:\u2233
*/
ANTICLOCKWISE_CONTOUR_INTEGRAL,
/**
* "⋀" Unicode:\u22c0
*/
NARY_LOGICAL_AND,
/**
* "⋁" Unicode:\u22c1
*/
NARY_LOGICAL_OR,
/**
* "⋂" Unicode:\u22c2
*/
NARY_INTERSECTION,
/**
* "⋃" Unicode:\u22c3
*/
NARY_UNION,
}
/**
* Utility class containing constants.
* 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(Usually with 'Equation' suffix. 'EquationParagraph' is a special case.).
* @enum {number}
*/
const EquationNodeType = {
/**
* UnKnow
*/
UN_KNOW,
/**
* specifies a node that stores math text
*/
TEXT,
/**
* Specifies a component of type 'Base'
*/
BASE,
/**
* Specifies a component of type 'Denominator'
*/
DENOMINATOR,
/**
* Specifies a component of type 'Numerator'
*/
NUMERATOR,
/**
* Specifies a component of type 'FunctionName'
*/
FUNCTION_NAME,
/**
* Specifies a component of type 'Subscript'
*/
SUBSCRIPT,
/**
* Specifies a component of type 'Superscript'
*/
SUPERSCRIPT,
/**
* Specifies a component of type 'Degree'
*/
DEGREE,
/**
* Specifies a component of type 'MatrixRow'.A single row of the matrix
*/
MATRIX_ROW,
/**
* Specifies a mathematical paragraph(oMathPara).
*/
EQUATION_PARAGRAPH,
/**
* Specifies an equation or mathematical expression(OMath).
*/
MATHEMATICAL_EQUATION,
/**
* Specifies fractional equation
*/
FRACTION_EQUATION,
/**
* Specifies function equation
*/
FUNCTION_EQUATION,
/**
* Specifies delimiter equation
*/
DELIMITER_EQUATION,
/**
* Specifies n-ary operator equation
*/
NARY_EQUATION,
/**
* Specifies the radical equation
*/
RADICAL_EQUATION,
/**
* Specifies superscript equation
*/
SUPERSCRIPT_EQUATION,
/**
* Specifies subscript equation
*/
SUBSCRIPT_EQUATION,
/**
* Specifies an equation with superscripts and subscripts to the right of the operands.
*/
SUB_SUP_EQUATION,
/**
* Specifies an equation with superscripts and subscripts to the left of the operands.
*/
PRE_SUB_SUP_EQUATION,
/**
* Specifies accent equation
*/
ACCENT_EQUATION,
/**
* Specifies bar equation
*/
BAR_EQUATION,
/**
* Specifies border box equation
*/
BORDER_BOX_EQUATION,
/**
* Specifies box equation
*/
BOX_EQUATION,
/**
* Specifies Group-Character equation
*/
GROUP_CHARACTER_EQUATION,
/**
* Specifies the Matrix equation,
*/
MATRIX_EQUATION,
}
/**
* Utility class containing constants.
* This specifies the default vertical justification of equations in the document.
* @enum {number}
*/
const EquationVerticalJustificationType = {
/**
* top
*/
TOP,
/**
* center
*/
CENTER,
/**
* bottom
*/
BOTTOM,
}
/**
* Utility class containing constants.
* Represents error bar display type.
* @enum {number}
*/
const ErrorBarDisplayType = {
/**
* Both
*/
BOTH,
/**
* Minus
*/
MINUS,
/**
* None
*/
NONE,
/**
* Plus
*/
PLUS,
}
/**
* Utility class containing constants.
* Represents error bar amount type.
* @enum {number}
*/
const ErrorBarType = {
/**
* InnerCustom value type.
*/
CUSTOM,
/**
* Fixed value type.
*/
FIXED_VALUE,
/**
* Percentage type
*/
PERCENT,
/**
* Standard deviation type.
*/
ST_DEV,
/**
* Standard error type.
*/
ST_ERROR,
}
/**
* Utility class containing constants.
* Represents all error check type.
* @enum {number}
*/
const ErrorCheckType = {
/**
* Ignore errors when cells contain formulas that result in an error.
*/
EVALUATION_ERROR,
/**
* NOTE: This member is now obsolete. Instead,
* please use ErrorCheckType.EvaluationError enum.
* This method will be removed 12 months later since October 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
CALC,
/**
* Ignore errors when formulas refer to empty cells.
*/
EMPTY_CELL_REF,
/**
* Ignore errors when numbers are formatted as text or are preceded by an apostrophe
*/
NUMBER_STORED_AS_TEXT,
/**
* Ignore errors when numbers are formatted as text or are preceded by an apostrophe
* 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.
*/
TEXT_NUMBER,
/**
* Ignore errors when formulas omit certain cells in a region.
*/
INCONSIST_RANGE,
/**
* Ignore errors when a formula in a region of your worksheet differs from other formulas in the same region.
*/
INCONSIST_FORMULA,
/**
* Ignore errors when formulas contain text formatted cells with years represented as 2 digits.
*/
TWO_DIGIT_TEXT_YEAR,
/**
* Ignore errors when formulas contain text formatted cells with years represented as 2 digits.
* 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.
*/
TEXT_DATE,
/**
* Ignore errors when unlocked cells contain formulas.
*/
UNLOCKED_FORMULA,
/**
* Ignore errors when unlocked cells contain formulas.
* 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.
*/
UNPROCTED_FORMULA,
/**
* Ignore errors when a cell's value in a Table does not comply with the Data Validation rules specified.
*/
TABLE_DATA_VALIDATION,
/**
* Ignore errors when a cell's value in a Table does not comply with the Data Validation rules specified.
* 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.
*/
VALIDATION,
/**
* Ignore errors when cells contain a value different from a calculated column formula.
*/
CALCULATED_COLUMN,
}
/**
* Utility class containing constants.
* Represents custom exception type code.
* @enum {number}
*/
const ExceptionType = {
/**
* Invalid chart setting.
*/
CHART,
/**
* Invalid data type setting.
*/
DATA_TYPE,
/**
* Invalid data validation setting.
*/
DATA_VALIDATION,
/**
* Invalid data validation setting.
*/
CONDITIONAL_FORMATTING,
/**
* Invalid file format.
*/
FILE_FORMAT,
/**
* Invalid formula.
*/
FORMULA,
/**
* Invalid data.
*/
INVALID_DATA,
/**
* Invalid operator.
*/
INVALID_OPERATOR,
/**
* Incorrect password.
*/
INCORRECT_PASSWORD,
/**
* License related errors.
*/
LICENSE,
/**
* Out of MS Excel limitation error.
*/
LIMITATION,
/**
* Invalid page setup setting.
*/
PAGE_SETUP,
/**
* Invalid pivotTable setting.
*/
PIVOT_TABLE,
/**
* Invalid drawing object setting.
*/
SHAPE,
/**
* Invalid sparkline object setting.
*/
SPARKLINE,
/**
* Invalid worksheet name.
*/
SHEET_NAME,
/**
* Invalid worksheet type.
*/
SHEET_TYPE,
/**
* The process is interrupted.
*/
INTERRUPTED,
/**
* The file is invalid.
*/
IO,
/**
* Permission is required to open this file.
*/
PERMISSION,
/**
* Unsupported feature.
*/
UNSUPPORTED_FEATURE,
/**
* Unsupported stream to be opened.
*/
UNSUPPORTED_STREAM,
/**
* Files contains some undisclosed information.
*/
UNDISCLOSED_INFORMATION,
/**
* File content is corrupted.
*/
FILE_CORRUPTED,
}
/**
* Utility class containing constants.
* Represents the type of external link.
* @enum {number}
*/
const ExternalLinkType = {
/**
* Represents the DDE link.
*/
DDE_LINK,
/**
* Represents external link.
*/
EXTERNAL,
}
/**
* Utility class containing constants.
* Represents the file format types.
* @enum {number}
*/
const FileFormatType = {
/**
* Comma-Separated Values(CSV) text file.
*/
CSV,
/**
* Office Open XML SpreadsheetML file (macro-free).
*/
XLSX,
/**
* Office Open XML SpreadsheetML Macro-Enabled file.
*/
XLSM,
/**
* Office Open XML SpreadsheetML Template (macro-free).
*/
XLTX,
/**
* Office Open XML SpreadsheetML Macro-Enabled Template.
*/
XLTM,
/**
* Office Open XML SpreadsheetML addinMacro-Enabled file.
*/
XLAM,
/**
* Tab-Separated Values(TSV) text file.
*/
TSV,
/**
* Tab-Separated Values(TSV) text file, same with TSV.
*/
TAB_DELIMITED,
/**
* HTML format.
*/
HTML,
/**
* MHTML (Web archive) format.
*/
M_HTML,
/**
* Open Document Sheet(ODS) file.
*/
ODS,
/**
* Excel97-2003 spreadsheet file.
*/
EXCEL_97_TO_2003,
/**
* Excel 2003 XML Data file.
*/
SPREADSHEET_ML,
/**
* The Excel Binary File Format (.xlsb)
*/
XLSB,
/**
* Represents unrecognized format, cannot be loaded.
*/
UNKNOWN,
/**
* PDF (Adobe Portable Document) format.
*/
PDF,
/**
* XPS (XML Paper Specification) format.
*/
XPS,
/**
* Represents a TIFF file.
*/
TIFF,
/**
* SVG file.
*/
SVG,
/**
* Represents an Excel95 xls file.
*/
EXCEL_95,
/**
* Represents an Excel4.0 xls file.
* The file format is not supported
*/
EXCEL_4,
/**
* Represents an Excel3.0 xls file.
* The file format is not supported
*/
EXCEL_3,
/**
* Represents an Excel2.1 xls file.
* The file format is not supported
*/
EXCEL_2,
/**
* Represents a pptx file.
* The file format is not supported
* Only for detecting file type.
*/
PPTX,
/**
* Represents a docx file.
* The file format is not supported
* Only for detecting file type.
*/
DOCX,
/**
* Data Interchange Format.
*/
DIF,
/**
* Represents a doc file.
* The file format is not supported
* Only for detecting file type.
*/
DOC,
/**
* Represents a ppt file.
* The file format is not supported
* Only for detecting file type.
*/
PPT,
/**
* Represents a email file.
* The file format is not supported
* Only for detecting file type.
*/
MAPI_MESSAGE,
/**
* Represents the MS Equation 3.0 object.
* The file format is not supported
* Only for detecting file type.
*/
MS_EQUATION,
/**
* Represents the embedded native object.
* The file format is not supported
* Only for detecting file type.
*/
OLE_10_NATIVE,
/**
* Represents MS Visio VSD binary format.
* The file format is not supported
* Only for detecting file type.
*/
VSD,
/**
* Represents MS Visio 2013 VSDX file format.
* The file format is not supported
* Only for detecting file type.
*/
VSDX,
/**
* Represents a docm file.
* The file format is not supported
* Only for detecting file type.
*/
DOCM,
/**
* Represents a dotx file.
* The file format is not supported
* Only for detecting file type.
*/
DOTX,
/**
* Represents a dotm file.
* The file format is not supported
* Only for detecting file type.
*/
DOTM,
/**
* Represents a pptm file.
* The file format is not supported
* Only for detecting file type.
*/
PPTM,
/**
* Represents a Potx file.
* The file format is not supported
* Only for detecting file type.
*/
POTX,
/**
* Represents a Potm file.
* The file format is not supported
* Only for detecting file type.
*/
POTM,
/**
* Represents a ppsx file.
* The file format is not supported
* Only for detecting file type.
*/
PPSX,
/**
* Represents a ppsm file.
* The file format is not supported
* Only for detecting file type.
*/
PPSM,
/**
* Represents office open xml file(such as xlsx, docx,pptx, etc).
* The file format is not supported
* Only for detecting file type.
* If the office open xml file is encrypted, it could not be detected as xlsx ,docx, pptx,etc.
*/
OOXML,
/**
* Represents an ODT file.
* The file format is not supported
* Only for detecting file type.
*/
ODT,
/**
* Represents a ODP file.
* The file format is not supported
* Only for detecting file type.
*/
ODP,
/**
* Represents an ODF file.
* The file format is not supported
* Only for detecting file type.
*/
ODF,
/**
* Represents an ODG file.
* The file format is not supported
* Only for detecting file type.
*/
ODG,
/**
* Represents a simple xml file.
* The file format is not supported
* Only for detecting file type.
*/
XML,
/**
* Excel97-2003 spreadsheet template.
*/
XLT,
/**
* Represents an OTT file.
* The file format is not supported
* Only for detecting file type.
*/
OTT,
/**
* Represents a BMP file.
* The file format is not supported
* Only for detecting file type.
*/
BMP,
/**
* Represents an ots file.
*/
OTS,
/**
* Represents Numbers 9.0 file format by Apple Inc.
* NOTE: This member is now obsolete. Instead,
* please use NUMBERS_09 property.
* This property will be removed 6 months later since June 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
NUMBERS,
/**
* Represents Numbers 9.0 file format by Apple Inc.
*/
NUMBERS_09,
/**
* Represents markdown document.
*/
MARKDOWN,
/**
* Represents embedded graph chart.
*/
GRAPH_CHART,
/**
* Represents OpenDocument Flat XML Spreadsheet (.fods) file format.
*/
FODS,
/**
* Represents StarOffice Calc Spreadsheet (.sxc) file format.
*/
SXC,
/**
* Represents a OTP file.
* The file format is not supported.
* Only for detecting file type.
*/
OTP,
/**
* Represents Numbers 3.5 file format since 2014 by Apple Inc
*/
NUMBERS_35,
/**
* Windows Enhanced Metafile.
*/
EMF,
/**
* Windows Metafile.
*/
WMF,
/**
* JPEG JFIF.
*/
JPG,
/**
* Portable Network Graphics.
*/
PNG,
/**
* Gif
*/
GIF,
/**
* Webp
*/
WEB_P,
/**
* Json
*/
JSON,
/**
* Sql
*/
SQL_SCRIPT,
/**
* Rrepesents XHtml file.
*/
X_HTML,
/**
* Rrepesents One Note file.
* The file format is not supported
* Only for detecting file type.
*/
ONE_NOTE,
/**
* ///
* Rrepesents Microsoft Cabinet file.
* The file format is not supported
* Only for detecting file type.
*/
MICROSOFT_CABINET,
/**
*/
RTF,
/**
* EPUB
*/
EPUB,
/**
* AZW3
*/
AZW_3,
/**
* OXPS (Open XML Paper Specification) format.
*/
OXPS,
/**
* Rrepesents GZip file.
* The file format is not supported
* Only for detecting file type.
*/
G_ZIP,
}
/**
* Utility class containing constants.
* Enumerates shape fill pattern types.
* @enum {number}
*/
const FillPattern = {
/**
* Represents no background.
*/
NONE,
/**
* Represents solid pattern.
*/
SOLID,
/**
* Represents 5% gray pattern.
*/
GRAY_5,
/**
* Represents 10% gray pattern.
*/
GRAY_10,
/**
* Represents 20% gray pattern.
*/
GRAY_20,
/**
* Represents 30% gray pattern.
*/
GRAY_30,
/**
* Represents 40% gray pattern.
*/
GRAY_40,
/**
* Represents 50% gray pattern.
*/
GRAY_50,
/**
* Represents 60% gray pattern.
*/
GRAY_60,
/**
* Represents 70% gray pattern.
*/
GRAY_70,
/**
* Represents 75% gray pattern.
*/
GRAY_75,
/**
* Represents 80% gray pattern.
*/
GRAY_80,
/**
* Represents 90% gray pattern.
*/
GRAY_90,
/**
* Represents 25% gray pattern.
*/
GRAY_25,
/**
* Represents light downward diagonal pattern.
*/
LIGHT_DOWNWARD_DIAGONAL,
/**
* Represents light upward diagonal pattern.
*/
LIGHT_UPWARD_DIAGONAL,
/**
* Represents dark downward diagonal pattern.
*/
DARK_DOWNWARD_DIAGONAL,
/**
* Represents dark upward diagonal pattern.
*/
DARK_UPWARD_DIAGONAL,
/**
* Represents wide downward diagonal pattern.
*/
WIDE_DOWNWARD_DIAGONAL,
/**
* Represents wide upward diagonal pattern.
*/
WIDE_UPWARD_DIAGONAL,
/**
* Represents light vertical pattern.
*/
LIGHT_VERTICAL,
/**
* Represents light horizontal pattern.
*/
LIGHT_HORIZONTAL,
/**
* Represents narrow vertical pattern.
*/
NARROW_VERTICAL,
/**
* Represents narrow horizontal pattern.
*/
NARROW_HORIZONTAL,
/**
* Represents dark vertical pattern.
*/
DARK_VERTICAL,
/**
* Represents dark horizontal pattern.
*/
DARK_HORIZONTAL,
/**
* Represents dashed downward diagonal pattern.
*/
DASHED_DOWNWARD_DIAGONAL,
/**
* Represents dashed upward diagonal pattern.
*/
DASHED_UPWARD_DIAGONAL,
/**
* Represents dashed vertical pattern.
*/
DASHED_VERTICAL,
/**
* Represents dashed horizontal pattern.
*/
DASHED_HORIZONTAL,
/**
* Represents small confetti pattern.
*/
SMALL_CONFETTI,
/**
* Represents large confetti pattern.
*/
LARGE_CONFETTI,
/**
* Represents zig zag pattern.
*/
ZIG_ZAG,
/**
* Represents wave pattern.
*/
WAVE,
/**
* Represents diagonal brick pattern.
*/
DIAGONAL_BRICK,
/**
* Represents horizontal brick pattern.
*/
HORIZONTAL_BRICK,
/**
* Represents weave pattern.
*/
WEAVE,
/**
* Represents plaid pattern.
*/
PLAID,
/**
* Represents divot pattern.
*/
DIVOT,
/**
* Represents dotted grid pattern.
*/
DOTTED_GRID,
/**
* Represents dotted diamond pattern.
*/
DOTTED_DIAMOND,
/**
* Represents shingle pattern.
*/
SHINGLE,
/**
* Represents trellis pattern.
*/
TRELLIS,
/**
* Represents sphere pattern.
*/
SPHERE,
/**
* Represents small grid pattern.
*/
SMALL_GRID,
/**
* Represents large grid pattern.
*/
LARGE_GRID,
/**
* Represents small checker board pattern.
*/
SMALL_CHECKER_BOARD,
/**
* Represents large checker board pattern.
*/
LARGE_CHECKER_BOARD,
/**
* Represents outlined diamond pattern.
*/
OUTLINED_DIAMOND,
/**
* Represents solid diamond pattern.
*/
SOLID_DIAMOND,
/**
* Represents unknown pattern.
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Represents the picture fill type.
* @enum {number}
*/
const FillPictureType = {
/**
* Stretch
*/
STRETCH,
/**
* Stack
*/
STACK,
/**
* StackAndScale
*/
STACK_AND_SCALE,
}
/**
* Utility class containing constants.
* Fill format type.
* @enum {number}
*/
const FillType = {
/**
* Represents automatic formatting type.
*/
AUTOMATIC,
/**
* Represents none formatting type.
*/
NONE,
/**
* Solid fill format.
*/
SOLID,
/**
* Gradient fill format.
*/
GRADIENT,
/**
* Texture fill format(includes picture fill).
*/
TEXTURE,
/**
* Pattern fill format.
*/
PATTERN,
/**
* Inherit the fill properties of the group.
*/
GROUP,
}
/**
* Utility class containing constants.
* Custom Filter operator type.
* @enum {number}
*/
const FilterOperatorType = {
/**
* Represents LessOrEqual operator.
*/
LESS_OR_EQUAL,
/**
* Represents LessThan operator.
*/
LESS_THAN,
/**
* Represents Equal operator.
*/
EQUAL,
/**
* Represents GreaterThan operator.
*/
GREATER_THAN,
/**
* Represents NotEqual operator.
*/
NOT_EQUAL,
/**
* Represents GreaterOrEqual operator.
*/
GREATER_OR_EQUAL,
/**
* Represents no comparison.
*/
NONE,
/**
* Begins with the text.
*/
BEGINS_WITH,
/**
* Ends with the text.
*/
ENDS_WITH,
/**
* Contains the text.
*/
CONTAINS,
/**
* Not contains the text.
*/
NOT_CONTAINS,
}
/**
* Utility class containing constants.
* The filter type.
* @enum {number}
*/
const FilterType = {
/**
* Filter by fill color of the cell.
*/
COLOR_FILTER,
/**
* Custom filter type.
*/
CUSTOM_FILTERS,
/**
* Dynamic filter type.
*/
DYNAMIC_FILTER,
/**
* 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.
*/
MULTIPLE_FILTERS,
/**
* Filter by icon of conditional formatting.
*/
ICON_FILTER,
/**
* Top 10 filter.
*/
TOP_10,
/**
* No filter.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the scheme type of the font.
* @enum {number}
*/
const FontSchemeType = {
/**
* None
*/
NONE,
/**
* Major scheme.
*/
MAJOR,
/**
* Minor scheme.
* The font's name will be automatically changed with the language.
*/
MINOR,
}
/**
* Utility class containing constants.
* Specifies the type of a font source.
* @enum {number}
*/
const FontSourceType = {
/**
* represents single font file.
*/
FONT_FILE,
/**
* represents folder with font files.
*/
FONTS_FOLDER,
/**
* represents single font in memory.
*/
MEMORY_FONT,
}
/**
* Utility class containing constants.
* Enumerates the font underline types.
* @enum {number}
*/
const FontUnderlineType = {
/**
* Represents no underline.
*/
NONE,
/**
* Represents single underline.
*/
SINGLE,
/**
* Represents double underline.
*/
DOUBLE,
/**
* Represents single accounting underline.
*/
ACCOUNTING,
/**
* Represents double accounting underline.
*/
DOUBLE_ACCOUNTING,
/**
* Represents Dashed Underline
*/
DASH,
/**
* Represents Thick Dash-Dot-Dot Underline
*/
DASH_DOT_DOT_HEAVY,
/**
* Represents Thick Dash-Dot Underline
*/
DASH_DOT_HEAVY,
/**
* Represents Thick Dashed Underline
*/
DASHED_HEAVY,
/**
* Represents Long Dashed Underline
*/
DASH_LONG,
/**
* Represents Thick Long Dashed Underline
*/
DASH_LONG_HEAVY,
/**
* Represents Dash-Dot Underline
*/
DOT_DASH,
/**
* Represents Dash-Dot-Dot Underline
*/
DOT_DOT_DASH,
/**
* Represents Dotted Underline
*/
DOTTED,
/**
* Represents Thick Dotted Underline
*/
DOTTED_HEAVY,
/**
* Represents Thick Underline
*/
HEAVY,
/**
* Represents Wave Underline
*/
WAVE,
/**
* Represents Double Wave Underline
*/
WAVY_DOUBLE,
/**
* Represents Heavy Wave Underline
*/
WAVY_HEAVY,
/**
* Represents Underline Non-Space Characters Only
*/
WORDS,
}
/**
* Utility class containing constants.
* Conditional format rule type.
* @enum {number}
*/
const FormatConditionType = {
/**
* This conditional formatting rule compares a cell value
* to a formula calculated result, using an operator.
*/
CELL_VALUE,
/**
* This conditional formatting rule contains a formula to
* evaluate. When the formula result is true, the cell is
* highlighted.
*/
EXPRESSION,
/**
* This conditional formatting rule highlights cells whose
* values fall in the top N or bottom N bracket, as
* specified.
*/
TOP_10,
/**
* This conditional formatting rule highlights unique
* values in the range.
*/
UNIQUE_VALUES,
/**
* This conditional formatting rule highlights duplicated
* values.
*/
DUPLICATE_VALUES,
/**
* This conditional formatting rule highlights cells
* containing given text. Equivalent to using the SEARCH()
* sheet function to determine whether the cell contains
* the text.
*/
CONTAINS_TEXT,
/**
* This conditional formatting rule highlights cells that
* do not contain given text. Equivalent of using SEARCH()
* sheet function to determine whether the cell contains
* the text or not.
*/
NOT_CONTAINS_TEXT,
/**
* This conditional formatting rule highlights cells in the
* range that begin with the given text. Equivalent to
* using the LEFT() sheet function and comparing values.
*/
BEGINS_WITH,
/**
* This conditional formatting rule highlights cells ending
* with given text. Equivalent to using the RIGHT() sheet
* function and comparing values.
*/
ENDS_WITH,
/**
* This conditional formatting rule highlights cells that
* are completely blank. Equivalent of using LEN(TRIM()).
* This means that if the cell contains only characters
* that TRIM() would remove, then it is considered blank.
* An empty cell is also considered blank.
*/
CONTAINS_BLANKS,
/**
* This conditional formatting rule highlights cells that
* are not blank. Equivalent of using LEN(TRIM()). This
* means that if the cell contains only characters that
* TRIM() would remove, then it is considered blank. An
* empty cell is also considered blank.
*/
NOT_CONTAINS_BLANKS,
/**
* This conditional formatting rule highlights cells with
* formula errors. Equivalent to using ISERROR() sheet
* function to determine if there is a formula error.
*/
CONTAINS_ERRORS,
/**
* This conditional formatting rule highlights cells
* without formula errors. Equivalent to using ISERROR()
* sheet function to determine if there is a formula error.
*/
NOT_CONTAINS_ERRORS,
/**
* This conditional formatting rule highlights cells
* containing dates in the specified time period. The
* underlying value of the cell is evaluated, therefore the
* cell does not need to be formatted as a date to be
* evaluated. For example, with a cell containing the
* value 38913 the conditional format shall be applied if
* the rule requires a value of 7/14/2006.
*/
TIME_PERIOD,
/**
* This conditional formatting rule highlights cells that
* are above or below the average for all values in the
* range.
*/
ABOVE_AVERAGE,
/**
* This conditional formatting rule creates a gradated
* color scale on the cells.
*/
COLOR_SCALE,
/**
* This conditional formatting rule displays a gradated
* data bar in the range of cells.
*/
DATA_BAR,
/**
* This conditional formatting rule applies icons to cells
* according to their values.
*/
ICON_SET,
}
/**
* Utility class containing constants.
* Condition value type.
* @enum {number}
*/
const FormatConditionValueType = {
/**
* The minimum/ midpoint / maximum value for the
* gradient is determined by a formula.
*/
FORMULA,
/**
* Indicates that the maximum value in the range shall be
* used as the maximum value for the gradient.
*/
MAX,
/**
* Indicates that the minimum value in the range shall be
* used as the minimum value for the gradient.
*/
MIN,
/**
* Indicates that the minimum / midpoint / maximum
* value for the gradient is specified by a constant
* numeric value.
*/
NUMBER,
/**
* 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,
/**
* Value indicates a percentile ranking in the range shall
* be used as the minimum / midpoint / maximum value
* for the gradient.
*/
PERCENTILE,
/**
* Indicates that the Automatic maximum value in the range shall be
* used as the Automatic maximum value for the gradient.
*/
AUTOMATIC_MAX,
/**
* Indicates that the Automatic minimum value in the range shall be
* used as the Automatic minimum value for the gradient.
*/
AUTOMATIC_MIN,
}
/**
* Utility class containing constants.
* Fill format set type.
* @enum {number}
*/
const FormatSetType = {
/**
* No Fill format.
*/
NONE,
/**
* Gradient fill format.
*/
IS_GRADIENT_SET,
/**
* Texture fill format.
*/
IS_TEXTURE_SET,
/**
* Pattern fill format.
*/
IS_PATTERN_SET,
}
/**
* Utility class containing constants.
* Represents the type of formatting applied to an Area object or a Line object.
* @enum {number}
*/
const FormattingType = {
/**
* Represents automatic formatting type.
*/
AUTOMATIC,
/**
* Represents custom formatting type.
*/
CUSTOM,
/**
* Represents none formatting type.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the gradient color type for the specified fill.
* @enum {number}
*/
const GradientColorType = {
/**
* No gradient color
*/
NONE,
/**
* One gradient color
*/
ONE_COLOR,
/**
* Preset gradient colors
*/
PRESET_COLORS,
/**
* Two gradient colors
*/
TWO_COLORS,
}
/**
* Utility class containing constants.
* Represents all direction type of gradient.
* @enum {number}
*/
const GradientDirectionType = {
/**
* FromUpperLeftCorner
*/
FROM_UPPER_LEFT_CORNER,
/**
* FromUpperRightCorner
*/
FROM_UPPER_RIGHT_CORNER,
/**
* FromLowerLeftCorner
*/
FROM_LOWER_LEFT_CORNER,
/**
* FromLowerRightCorner
*/
FROM_LOWER_RIGHT_CORNER,
/**
* FromCenter
*/
FROM_CENTER,
/**
* Unknown
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Represents all Gradient fill type.
* @enum {number}
*/
const GradientFillType = {
/**
* Linear
*/
LINEAR,
/**
* Radial
*/
RADIAL,
/**
* Rectangle
*/
RECTANGLE,
/**
* Path
*/
PATH,
}
/**
* Utility class containing constants.
* Represents gradient preset color type.
* @enum {number}
*/
const GradientPresetType = {
/**
* Brass preset color
*/
BRASS,
/**
* Calm Water preset color
*/
CALM_WATER,
/**
* Chrome preset color
*/
CHROME,
/**
* Chrome II preset color
*/
CHROME_II,
/**
* Daybreak preset color
*/
DAYBREAK,
/**
* Desert preset color
*/
DESERT,
/**
* Early Sunset preset color
*/
EARLY_SUNSET,
/**
* Fire preset color
*/
FIRE,
/**
* Fog preset color
*/
FOG,
/**
* Gold preset color
*/
GOLD,
/**
* Gold II preset color
*/
GOLD_II,
/**
* Horizon preset color
*/
HORIZON,
/**
* Late Sunset preset color
*/
LATE_SUNSET,
/**
* Mahogany preset color
*/
MAHOGANY,
/**
* Moss preset color
*/
MOSS,
/**
* Nightfall preset color
*/
NIGHTFALL,
/**
* Ocean preset color
*/
OCEAN,
/**
* Parchment preset color
*/
PARCHMENT,
/**
* Peacock preset color
*/
PEACOCK,
/**
* Rainbow preset color
*/
RAINBOW,
/**
* Rainbow II preset color
*/
RAINBOW_II,
/**
* Sapphire preset color
*/
SAPPHIRE,
/**
* Silver preset color
*/
SILVER,
/**
* Wheat preset color
*/
WHEAT,
/**
* Unknown preset color.
* Only for the preset color (which is not same as any known preset color) in the template workbook.
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Represents gradient shading style.
* @enum {number}
*/
const GradientStyleType = {
/**
* Diagonal down shading style
*/
DIAGONAL_DOWN,
/**
* Diagonal up shading style
*/
DIAGONAL_UP,
/**
* From center shading style
*/
FROM_CENTER,
/**
* From corner shading style
*/
FROM_CORNER,
/**
* Horizontal shading style
*/
HORIZONTAL,
/**
* Vertical shading style
*/
VERTICAL,
/**
* Unknown shading style.Only for the shading style(which is not for any member of the GradientStyleType) in the template file.
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Enumerates grid line Type.
* @enum {number}
*/
const GridlineType = {
/**
* Represents dotted line.
*/
DOTTED,
/**
* Represents hair line.
*/
HAIR,
}
/**
* Utility class containing constants.
* Represents the command type of header and footer.
* @enum {number}
*/
const HeaderFooterCommandType = {
/**
* The text.
*/
TEXT,
/**
* Current page number
*/
CURRENT_PAGE,
/**
* Page count
*/
PAGECOUNT,
/**
* Current date
*/
CURRENT_DATE,
/**
* Current time
*/
CURRENT_TIME,
/**
* Sheet name
*/
SHEET_NAME,
/**
* File name without path
*/
FILE_NAME,
/**
* File path without file name
*/
FILE_PATH,
/**
* Picture
*/
PICTURE,
}
/**
* Utility class containing constants.
* Represents five types of html cross string.
* @enum {number}
*/
const 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,
/**
* Display the string like MS Excel exporting html.
*/
MS_EXPORT,
/**
* 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,
/**
* Display HTML cross string and hide the right string when the texts overlap.
*/
CROSS_HIDE_RIGHT,
/**
* Only displaying the string within the width of cell.
*/
FIT_TO_CELL,
}
/**
* Utility class containing constants.
* Represents the options for exporting html data.
* @enum {number}
*/
const HtmlExportDataOptions = {
/**
* Export file to html which only contains table part.
*/
TABLE,
/**
* Export all the data to html.
*/
ALL,
}
/**
* Utility class containing constants.
* Specifies how to handle formatting from the HTML source
* @enum {number}
*/
const HtmlFormatHandlingType = {
/**
* Transfer all HTML formatting into the worksheet along with data.
*/
ALL,
/**
* Bring data in as unformatted text (setting data types still occurs).
*/
NONE,
/**
* Translate HTML formatting to rich text formatting on the data brought into the worksheet.
*/
RTF,
}
/**
* Utility class containing constants.
* Represents two types of showing the hidden columns in html.
* @enum {number}
*/
const HtmlHiddenColDisplayType = {
/**
* Hidden the hidden columns in html page.
*/
HIDDEN,
/**
* Remove the hidden columns in html page.
*/
REMOVE,
}
/**
* Utility class containing constants.
* Represents two types of showing the hidden rows in html.
* @enum {number}
*/
const HtmlHiddenRowDisplayType = {
/**
* Hidden the hidden rows in html page.
*/
HIDDEN,
/**
* Remove the hidden rows in html page.
*/
REMOVE,
}
/**
* Utility class containing constants.
* Represents the type of target attribute in HTML tag.
* @enum {number}
*/
const HtmlLinkTargetType = {
/**
* Opens the linked document in a new window or tab
*/
BLANK,
/**
* Opens the linked document in the parent frame
*/
PARENT,
/**
* Opens the linked document in the same frame as it was clicked (this is default)
*/
SELF,
/**
* Opens the linked document in the full body of the window
*/
TOP,
}
/**
* Utility class containing constants.
* 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.
* @enum {number}
*/
const IconSetType = {
/**
* 3 arrows icon set.
*/
ARROWS_3,
/**
* 3 gray arrows icon set.
*/
ARROWS_GRAY_3,
/**
* 3 flags icon set.
*/
FLAGS_3,
/**
* 3 signs icon set.
*/
SIGNS_3,
/**
* 3 symbols icon set (circled).
*/
SYMBOLS_3,
/**
* 3 Symbols icon set (uncircled).
*/
SYMBOLS_32,
/**
* 3 traffic lights icon set (unrimmed).
*/
TRAFFIC_LIGHTS_31,
/**
* 3 traffic lights icon set with thick black border.
*/
TRAFFIC_LIGHTS_32,
/**
* 4 arrows icon set.
*/
ARROWS_4,
/**
* 4 gray arrows icon set.
*/
ARROWS_GRAY_4,
/**
* 4 ratings icon set.
*/
RATING_4,
/**
* 4 'red to black' icon set.
*/
RED_TO_BLACK_4,
/**
* 4 traffic lights icon set.
*/
TRAFFIC_LIGHTS_4,
/**
* 5 arrows icon set.
*/
ARROWS_5,
/**
* 5 gray arrows icon set.
*/
ARROWS_GRAY_5,
/**
* 5 quarters icon set.
*/
QUARTERS_5,
/**
* 5 rating icon set.
*/
RATING_5,
/**
* 3 stars set
*/
STARS_3,
/**
* 5 boxes set
*/
BOXES_5,
/**
* 3 triangles set
*/
TRIANGLES_3,
/**
* None
*/
NONE,
/**
* CustomSet.
* This element is read-only.
*/
CUSTOM_SET,
/**
* 3 smilies.
* Only for .ods.
*/
SMILIES_3,
/**
* 3 color smilies.
* Only for .ods.
*/
COLOR_SMILIES_3,
}
/**
* Utility class containing constants.
* Specifies the method used to binarize image.
* @enum {number}
*/
const ImageBinarizationMethod = {
/**
* Specifies threshold method.
*/
THRESHOLD,
/**
* Specifies dithering using Floyd-Steinberg error diffusion method.
*/
FLOYD_STEINBERG_DITHERING,
}
/**
* Utility class containing constants.
* Specifies the type (format) of an image.
* @enum {number}
*/
const ImageType = {
/**
* An unknown image type.
*/
UNKNOWN,
/**
* Windows Enhanced Metafile.
*/
EMF,
/**
* Windows Metafile.
*/
WMF,
/**
* Macintosh PICT.
*/
PICT,
/**
* JPEG JFIF.
*/
JPEG,
/**
* Portable Network Graphics.
*/
PNG,
/**
* Windows Bitmap
*/
BMP,
/**
* Gif
*/
GIF,
/**
* Tiff
*/
TIFF,
/**
* Svg
*/
SVG,
/**
* Svm
*/
SVM,
/**
* glTF
*/
GLTF,
/**
* Windows Enhanced Metafile which is more compatible with Office.
*/
OFFICE_COMPATIBLE_EMF,
/**
* Weppy image format
*/
WEB_P,
}
/**
* Utility class containing constants.
* Represents the default run-time mode of the Input Method Editor.
* @enum {number}
*/
const InputMethodEditorMode = {
/**
* Does not control IME.
*/
NO_CONTROL,
/**
* IME on.
*/
ON,
/**
* IME off. English mode.
*/
OFF,
/**
* IME off.User can't turn on IME by keyboard.
*/
DISABLE,
/**
* IME on with Full-width hiragana mode.
*/
HIRAGANA,
/**
* IME on with Full-width katakana mode.
*/
KATAKANA,
/**
* IME on with Half-width katakana mode.
*/
KATAKANA_HALF,
/**
* IME on with Full-width Alphanumeric mode.
*/
ALPHA_FULL,
/**
* IME on with Half-width Alphanumeric mode.
*/
ALPHA,
/**
* IME on with Full-width hangul mode.
*/
HANGUL_FULL,
/**
* IME on with Half-width hangul mode.
*/
HANGUL,
/**
* IME on with Full-width hanzi mode.
*/
HANZI_FULL,
/**
* IME on with Half-width hanzi mode.
*/
HANZI,
}
/**
* Utility class containing constants.
* Represents type of exporting hyperlinks to json.
* @enum {number}
*/
const JsonExportHyperlinkType = {
/**
* Export display string
*/
DISPLAY_STRING,
/**
* Export url
*/
ADDRESS,
/**
* Export as html string.
*/
HTML_STRING,
}
/**
* Utility class containing constants.
* Represents data label position type.
* @enum {number}
*/
const LabelPositionType = {
/**
* Applies only to bar, 2d/3d pie charts
*/
CENTER,
/**
* Applies only to bar, 2d/3d pie charts
*/
INSIDE_BASE,
/**
* Applies only to bar charts
*/
INSIDE_END,
/**
* Applies only to bar, 2d/3d pie charts
*/
OUTSIDE_END,
/**
* Applies only to line charts
*/
ABOVE,
/**
* Applies only to line charts
*/
BELOW,
/**
* Applies only to line charts
*/
LEFT,
/**
* Applies only to line charts
*/
RIGHT,
/**
* Applies only to 2d/3d pie charts
*/
BEST_FIT,
/**
* User moved the data labels, Only for reading chart from template file.
*/
MOVED,
}
/**
* Utility class containing constants.
* Enumerates the legend position types.
* @enum {number}
*/
const LegendPositionType = {
/**
* Displays the legend to the bottom of the chart's plot area.
*/
BOTTOM,
/**
* Displays the legend to the corner of the chart's plot area.
*/
CORNER,
/**
* Displays the legend to the left of the chart's plot area.
*/
LEFT,
/**
* Represents that the legend is not docked.
*/
NOT_DOCKED,
/**
* Displays the legend to the right of the chart's plot area.
*/
RIGHT,
/**
* Displays the legend to the top of the chart's plot area.
*/
TOP,
}
/**
* Utility class containing constants.
* Represents the light rig direction type.
* @enum {number}
*/
const LightRigDirectionType = {
/**
* Bottom
*/
BOTTOM,
/**
* Bottom left.
*/
BOTTOM_LEFT,
/**
* Bottom Right.
*/
BOTTOM_RIGHT,
/**
* Left.
*/
LEFT,
/**
* Right.
*/
RIGHT,
/**
* Top.
*/
TOP,
/**
* Top left.
*/
TOP_LEFT,
/**
* Top Right.
*/
TOP_RIGHT,
}
/**
* Utility class containing constants.
* Represents a preset light right that can be applied to a shape
* @enum {number}
*/
const LightRigType = {
/**
* Balanced
*/
BALANCED,
/**
* Bright room
*/
BRIGHT_ROOM,
/**
* Chilly
*/
CHILLY,
/**
* Contrasting
*/
CONTRASTING,
/**
* Flat
*/
FLAT,
/**
* Flood
*/
FLOOD,
/**
* Freezing
*/
FREEZING,
/**
* Glow
*/
GLOW,
/**
* Harsh
*/
HARSH,
/**
* LegacyFlat1
*/
LEGACY_FLAT_1,
/**
* LegacyFlat2
*/
LEGACY_FLAT_2,
/**
* LegacyFlat3
*/
LEGACY_FLAT_3,
/**
* LegacyFlat4
*/
LEGACY_FLAT_4,
/**
* LegacyHarsh1
*/
LEGACY_HARSH_1,
/**
* LegacyHarsh2
*/
LEGACY_HARSH_2,
/**
* LegacyHarsh3
*/
LEGACY_HARSH_3,
/**
* LegacyHarsh4
*/
LEGACY_HARSH_4,
/**
* LegacyNormal1
*/
LEGACY_NORMAL_1,
/**
* LegacyNormal2
*/
LEGACY_NORMAL_2,
/**
* LegacyNormal3
*/
LEGACY_NORMAL_3,
/**
* LegacyNormal4
*/
LEGACY_NORMAL_4,
/**
* Morning
*/
MORNING,
/**
* Soft
*/
SOFT,
/**
* Sunrise
*/
SUNRISE,
/**
* Sunset
*/
SUNSET,
/**
* Three point
*/
THREE_POINT,
/**
* Two point
*/
TWO_POINT,
/**
* No light rig.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the caps of a line
* @enum {number}
*/
const LineCapType = {
/**
* Square protrudes by half line width.
*/
SQUARE,
/**
* Rounded ends.
*/
ROUND,
/**
* Line ends at end point.
*/
FLAT,
/**
* None cap
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the join styles of a line.
* @enum {number}
*/
const LineJoinType = {
/**
* Round joint
*/
ROUND,
/**
* Bevel joint
*/
BEVEL,
/**
* Miter joint
*/
MITER,
/**
* None joint
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the unit type of line space size.
* @enum {number}
*/
const LineSpaceSizeType = {
/**
* Represents in unit of a percentage of the text size.
*/
PERCENTAGE,
/**
* Represents in unit of points.
*/
POINTS,
}
/**
* Utility class containing constants.
* Enumerates the type of Picture border or Chart line.
* @enum {number}
*/
const LineType = {
/**
* Represents a dark gray line.
*/
DARK_GRAY,
/**
* Represent a dash line.
*/
DASH,
/**
* Represents a dash-dot line
*/
DASH_DOT,
/**
* Represents a dash-dot-dot line.
*/
DASH_DOT_DOT,
/**
* Represents a dotted line.
*/
DOT,
/**
* Represents a light gray line.
*/
LIGHT_GRAY,
/**
* Represents a medium gray line.
*/
MEDIUM_GRAY,
/**
* Represent a solid line.
*/
SOLID,
}
/**
* Utility class containing constants.
* Represents the options to filter data when loading workbook from template.
* @enum {number}
*/
const LoadDataFilterOptions = {
/**
* Load nothing for sheet data
* 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.
*/
NONE,
/**
* Load all
*/
ALL,
/**
* Load cells whose value is blank
*/
CELL_BLANK,
/**
* Load cells whose value is string
*/
CELL_STRING,
/**
* Load cells whose value is numeric(including datetime)
*/
CELL_NUMERIC,
/**
* Load cells whose value is error
*/
CELL_ERROR,
/**
* Load cells whose value is bool
*/
CELL_BOOL,
/**
* Load cells value(all value types) only
*/
CELL_VALUE,
/**
* Load cell formulas.
* 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,
/**
* Load cells data including values, formulas and formatting
*/
CELL_DATA,
/**
* Load charts
*/
CHART,
/**
* Load shapes
* 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.
*/
SHAPE,
/**
* Drawing objects(including Chart, Picture, OleObject and all other drawing objects)
*/
DRAWING,
/**
* Load merged cells
*/
MERGED_AREA,
/**
* Load conditional formatting
*/
CONDITIONAL_FORMATTING,
/**
* Load data validations
*/
DATA_VALIDATION,
/**
* Load pivot tables
*/
PIVOT_TABLE,
/**
* Load tables
*/
TABLE,
/**
* Load hyperlinks
*/
HYPERLINKS,
/**
* Load settings for worksheet
*/
SHEET_SETTINGS,
/**
* Load all data of worksheet, such as cells data, settings, objects, ...etc.
*/
SHEET_DATA,
/**
* Load settings for workbook
*/
BOOK_SETTINGS,
/**
* Load settings for workbook and worksheet
*/
SETTINGS,
/**
* Load XmlMap
*/
XML_MAP,
/**
* Load structure of the workbook
*/
STRUCTURE,
/**
* Load document properties
*/
DOCUMENT_PROPERTIES,
/**
* Load defined Name objects
*/
DEFINED_NAMES,
/**
* Load VBA projects
*/
VBA,
/**
* Load styles for cell formatting
*/
STYLE,
/**
* Load pictures
*/
PICTURE,
/**
* Load OleObjects
*/
OLE_OBJECT,
/**
* Load revision logs
*/
REVISION,
}
/**
* Utility class containing constants.
* Represents the load file format.
* @enum {number}
*/
const LoadFormat = {
/**
* Represents recognizing the format automatically.
*/
AUTO,
/**
* Comma-Separated Values(CSV) text file.
*/
CSV,
/**
* Represents Office Open XML spreadsheetML workbook or template, with or without macros.
*/
XLSX,
/**
* Tab-Separated Values(TSV) text file.
*/
TSV,
/**
* Represents a tab delimited text file, same with TSV.
*/
TAB_DELIMITED,
/**
* Represents a html file.
*/
HTML,
/**
* Represents a mhtml file.
*/
M_HTML,
/**
* Open Document Sheet(ODS) file.
*/
ODS,
/**
* Represents an Excel97-2003 xls file.
*/
EXCEL_97_TO_2003,
/**
* Represents an Excel 2003 xml file.
*/
SPREADSHEET_ML,
/**
* Represents an xlsb file.
*/
XLSB,
/**
* Open Document Template Sheet(OTS) file.
*/
OTS,
/**
* Represents a numbers file.
*/
NUMBERS,
/**
* Represents OpenDocument Flat XML Spreadsheet (.fods) file format.
*/
FODS,
/**
* Represents StarOffice Calc Spreadsheet (.sxc) file format.
*/
SXC,
/**
* Represents a simple xml file.
*/
XML,
/**
* Reprents an EPUB file.
*/
EPUB,
/**
* Represents an AZW3 file.
*/
AZW_3,
/**
* Represents unrecognized format, cannot be loaded.
*/
UNKNOWN,
/**
* Image
*/
IMAGE,
/**
* Json
*/
JSON,
}
/**
* Utility class containing constants.
* Indicates type of loading tables when some tables are in a sheet.
* @enum {number}
*/
const LoadNumbersTableType = {
/**
*/
ONE_TABLE_PER_SHEET,
/**
*/
OVERRIDE_OTHER_TABLES,
/**
*/
TILE_TABLES,
}
/**
* Utility class containing constants.
* Represents look at type.
* @enum {number}
*/
const LookAtType = {
/**
* Cell value Contains the find object.
*/
CONTAINS,
/**
* Cell value Starts with the find object.
*/
START_WITH,
/**
* Cell value ends with the find object.
*/
END_WITH,
/**
* Cell value is same as the find object.
*/
ENTIRE_CONTENT,
}
/**
* Utility class containing constants.
* Represents look in type.
* @enum {number}
*/
const LookInType = {
/**
* If the cell contains a formula, find object from formula, else find it from the value.
*/
FORMULAS,
/**
* Only find object from the formatted values.
*/
VALUES,
/**
* Only find object from the values of cells which do not contains formula.
*/
VALUES_EXCLUDE_FORMULA_CELL,
/**
* Only find object from the comments.
*/
COMMENTS,
/**
* Only find object from formulas.
*/
ONLY_FORMULAS,
/**
* Only find object from the original values.
*/
ORIGINAL_VALUES,
}
/**
* Utility class containing constants.
* Represents the layout of map chart's labels.
* @enum {number}
*/
const MapChartLabelLayout = {
/**
* Only best fit.
*/
BEST_FIT_ONLY,
/**
* Shows all labels.
*/
SHOW_ALL,
/**
* No labels.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents projection type of the map chart.
* @enum {number}
*/
const MapChartProjectionType = {
/**
* Automatic
*/
AUTOMATIC,
/**
* Mercator
*/
MERCATOR,
/**
* Miller
*/
MILLER,
/**
* Albers
*/
ALBERS,
}
/**
* Utility class containing constants.
* Represents the region type of the map chart.
* @enum {number}
*/
const MapChartRegionType = {
/**
* Automatic
*/
AUTOMATIC,
/**
* Only Data.
*/
DATA_ONLY,
/**
* Country region list.
*/
COUNTRY_REGION_LIST,
/**
* World.
*/
WORLD,
}
/**
* Utility class containing constants.
* Memory usage options.
* @enum {number}
*/
const MemorySetting = {
/**
* Default option for cells model.
* This option is applied for all versions.
*/
NORMAL,
/**
* Memory performance preferrable.
* With this option the data will be held in compact format so for common scenarios it may give lower memory cost.
* However, this option also may degrade R/W performance a bit in some special cases.
* This option is available since v 8.0.0.
*/
MEMORY_PREFERENCE,
}
/**
* Utility class containing constants.
* Represents the merge type for empty TD element when exporting file to html.
* @enum {number}
*/
const MergeEmptyTdType = {
/**
* Display like MS Excel.
*/
DEFAULT,
/**
* Empty TD elements will not be merged when exporting file to html.
* This will generate a significantly larger html file.
*/
NONE,
/**
* 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.
*/
MERGE_FORCELY,
}
/**
* Utility class containing constants.
* Represents the type of metadata.
* @enum {number}
*/
const MetadataType = {
/**
* Encrypts the file.
*/
ENCRYPTION,
/**
* Decrypts the file.
*/
DECRYPTION,
/**
* Load the properties of the file.
*/
DOCUMENT_PROPERTIES,
}
/**
* Utility class containing constants.
* Represents mirror type of texture fill
* @enum {number}
*/
const MirrorType = {
/**
* None
*/
NONE,
/**
* Horizonal
*/
HORIZONAL,
/**
* Vertical
*/
VERTICAL,
/**
* Both
*/
BOTH,
}
/**
* Utility class containing constants.
* Enumerates the line end width of the shape border line.
* @enum {number}
*/
const MsoArrowheadLength = {
/**
* Short line end length
*/
SHORT,
/**
* Medium line end length
*/
MEDIUM,
/**
* Long line end length
*/
LONG,
}
/**
* Utility class containing constants.
* Enumerates the line end type of the shape border line.
* @enum {number}
*/
const MsoArrowheadStyle = {
/**
* No line end type.
*/
NONE,
/**
* Arrow line end type.
*/
ARROW,
/**
* Arrow Stealth line end type.
*/
ARROW_STEALTH,
/**
* Arrow Diamond Line end type.
*/
ARROW_DIAMOND,
/**
* Arrow Oval line end type.
*/
ARROW_OVAL,
/**
* Arrow Open line end type.
*/
ARROW_OPEN,
}
/**
* Utility class containing constants.
* Enumerates the line end width of the shape border line.
* @enum {number}
*/
const MsoArrowheadWidth = {
/**
* Short line end width.
*/
NARROW,
/**
* Medium line end width.
*/
MEDIUM,
/**
* Wide line end width.
*/
WIDE,
}
/**
* Utility class containing constants.
* Represents office drawing objects type.
* @enum {number}
*/
const MsoDrawingType = {
/**
* Group
*/
GROUP,
/**
* Line
*/
LINE,
/**
* Rectangle
*/
RECTANGLE,
/**
* Oval
*/
OVAL,
/**
* Arc
*/
ARC,
/**
* Chart
*/
CHART,
/**
* TextBox
*/
TEXT_BOX,
/**
* Button
*/
BUTTON,
/**
* Picture
*/
PICTURE,
/**
* Polygon
*/
POLYGON,
/**
* CheckBox
*/
CHECK_BOX,
/**
* RadioButton
*/
RADIO_BUTTON,
/**
* Label
*/
LABEL,
/**
* DialogBox
*/
DIALOG_BOX,
/**
* Spinner
*/
SPINNER,
/**
* ScrollBar
*/
SCROLL_BAR,
/**
* ListBox
*/
LIST_BOX,
/**
* GroupBox
*/
GROUP_BOX,
/**
* ComboBox
*/
COMBO_BOX,
/**
* Comment
*/
COMMENT,
/**
* OleObject
*/
OLE_OBJECT,
/**
* Only for preserving the drawing object in the template file.
*/
CELLS_DRAWING,
/**
* Only for preserving the drawing object in the xlsx file.
*/
UNKNOWN,
/**
* Slicer
*/
SLICER,
/**
* Web extension
*/
WEB_EXTENSION,
/**
* Smart Art
*/
SMART_ART,
/**
* Custom xml shape ,such as Ink.
*/
CUSTOM_XML,
/**
* Timeline
*/
TIMELINE,
/**
* 3D Model
*/
MODEL_3_D,
}
/**
* Utility class containing constants.
* Represents style of dash drawing lines.
* @enum {number}
*/
const MsoLineDashStyle = {
/**
* Represent a dash line.
*/
DASH,
/**
* Represents a dash-dot line.
*/
DASH_DOT,
/**
* Represents a dash-dot-dot line.
*/
DASH_DOT_DOT,
/**
* Represents a long dash-short dash line.
*/
DASH_LONG_DASH,
/**
* Represents a long dash-short dash-dot line.
*/
DASH_LONG_DASH_DOT,
/**
* Represents a round-dot line.
*/
ROUND_DOT,
/**
* Represent a solid line.
*/
SOLID,
/**
* Represents a square-dot line.
*/
SQUARE_DOT,
/**
* Custom dash style.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents style of drawing lines.
* @enum {number}
*/
const MsoLineStyle = {
/**
* Single line (of width lineWidth)
*/
SINGLE,
/**
* Three lines, thin, thick, thin
*/
THICK_BETWEEN_THIN,
/**
* Double lines, one thin, one thick
*/
THIN_THICK,
/**
* Double lines, one thick, one thin
*/
THICK_THIN,
/**
* Double lines of equal width
*/
THIN_THIN,
}
/**
* Utility class containing constants.
* Represents preset text effect type of WordArt.
* @enum {number}
*/
const MsoPresetTextEffect = {
/**
* TextEffect1
*/
TEXT_EFFECT_1,
/**
* TextEffect2
*/
TEXT_EFFECT_2,
/**
* TextEffect3
*/
TEXT_EFFECT_3,
/**
* TextEffect4
*/
TEXT_EFFECT_4,
/**
* TextEffect5
*/
TEXT_EFFECT_5,
/**
* TextEffect6
*/
TEXT_EFFECT_6,
/**
* TextEffect7
*/
TEXT_EFFECT_7,
/**
* TextEffect8
*/
TEXT_EFFECT_8,
/**
* TextEffect9
*/
TEXT_EFFECT_9,
/**
* TextEffect10
*/
TEXT_EFFECT_10,
/**
* TextEffect11
*/
TEXT_EFFECT_11,
/**
* TextEffect12
*/
TEXT_EFFECT_12,
/**
* TextEffect13
*/
TEXT_EFFECT_13,
/**
* TextEffect14
*/
TEXT_EFFECT_14,
/**
* TextEffect15
*/
TEXT_EFFECT_15,
/**
* TextEffect16
*/
TEXT_EFFECT_16,
/**
* TextEffect17
*/
TEXT_EFFECT_17,
/**
* TextEffect18
*/
TEXT_EFFECT_18,
/**
* TextEffect19
*/
TEXT_EFFECT_19,
/**
* TextEffect20
*/
TEXT_EFFECT_20,
/**
* TextEffect21
*/
TEXT_EFFECT_21,
/**
* TextEffect22
*/
TEXT_EFFECT_22,
/**
* TextEffect23
*/
TEXT_EFFECT_23,
/**
* TextEffect24
*/
TEXT_EFFECT_24,
/**
* TextEffect25
*/
TEXT_EFFECT_25,
/**
* TextEffect26
*/
TEXT_EFFECT_26,
/**
* TextEffect27
*/
TEXT_EFFECT_27,
/**
* TextEffect28
*/
TEXT_EFFECT_28,
/**
* TextEffect29
*/
TEXT_EFFECT_29,
/**
* TextEffect30
*/
TEXT_EFFECT_30,
}
/**
* Utility class containing constants.
* Represents preset text effect shape type of WordArt.
* @enum {number}
*/
const MsoPresetTextEffectShape = {
/**
* PlainText
*/
PLAIN_TEXT,
/**
* Stop
*/
STOP,
/**
* TriangleUp
*/
TRIANGLE_UP,
/**
* TriangleDown
*/
TRIANGLE_DOWN,
/**
* ChevronUp
*/
CHEVRON_UP,
/**
* ChevronDown
*/
CHEVRON_DOWN,
/**
* RingInside
*/
RING_INSIDE,
/**
* RingOutside
*/
RING_OUTSIDE,
/**
* ArchUpCurve
*/
ARCH_UP_CURVE,
/**
* ArchDownCurve
*/
ARCH_DOWN_CURVE,
/**
* CircleCurve
*/
CIRCLE_CURVE,
/**
* ButtonCurve
*/
BUTTON_CURVE,
/**
* ArchUpPour
*/
ARCH_UP_POUR,
/**
* ArchDownPour
*/
ARCH_DOWN_POUR,
/**
* CirclePour
*/
CIRCLE_POUR,
/**
* ButtonPour
*/
BUTTON_POUR,
/**
* CurveUp
*/
CURVE_UP,
/**
* CurveDown
*/
CURVE_DOWN,
/**
* CanUp
*/
CAN_UP,
/**
* CanDown
*/
CAN_DOWN,
/**
* Wave1
*/
WAVE_1,
/**
* Wave2
*/
WAVE_2,
/**
* DoubleWave1
*/
DOUBLE_WAVE_1,
/**
* DoubleWave2
*/
DOUBLE_WAVE_2,
/**
* Inflate
*/
INFLATE,
/**
* Deflate
*/
DEFLATE,
/**
* InflateBottom
*/
INFLATE_BOTTOM,
/**
* DeflateBottom
*/
DEFLATE_BOTTOM,
/**
* InflateTop
*/
INFLATE_TOP,
/**
* DeflateTop
*/
DEFLATE_TOP,
/**
* DeflateInflate
*/
DEFLATE_INFLATE,
/**
* DeflateInflateDeflate
*/
DEFLATE_INFLATE_DEFLATE,
/**
* FadeRight
*/
FADE_RIGHT,
/**
* FadeLeft
*/
FADE_LEFT,
/**
* FadeUp
*/
FADE_UP,
/**
* FadeDown
*/
FADE_DOWN,
/**
* SlantUp
*/
SLANT_UP,
/**
* SlantDown
*/
SLANT_DOWN,
/**
* CascadeUp
*/
CASCADE_UP,
/**
* CascadeDown
*/
CASCADE_DOWN,
/**
* Mixed
*/
MIXED,
}
/**
* Utility class containing constants.
* Represents the scope type of defined names.
* @enum {number}
*/
const NameScopeType = {
/**
* All defined names.
*/
ALL,
/**
* The defined names in the workbook.
*/
WORKBOOK,
/**
* The defined names in a worksheet or all worksheets.
*/
WORKSHEET,
}
/**
* Utility class containing constants.
* Represents category type of cell's number formatting.
* @enum {number}
*/
const NumberCategoryType = {
/**
* General
*/
GENERAL,
/**
* Text
*/
TEXT,
/**
* Number
*/
NUMBER,
/**
* Date or Date and Time
*/
DATE,
/**
* Time
*/
TIME,
/**
* Fraction
*/
FRACTION,
/**
* Scientific
*/
SCIENTIFIC,
}
/**
* Utility class containing constants.
* Represents the cell field type of ods.
* @enum {number}
*/
const OdsCellFieldType = {
/**
* Current date.
*/
DATE,
/**
* The name of the sheet.
*/
SHEET_NAME,
/**
* The name of the file.
*/
TITLE,
}
/**
* Utility class containing constants.
* Represents the type of ODS generator.
* @enum {number}
*/
const OdsGeneratorType = {
/**
* Libre Office
*/
LIBRE_OFFICE,
/**
* Open Office
*/
OPEN_OFFICE,
}
/**
* Utility class containing constants.
* Represents the position.
* @enum {number}
*/
const OdsPageBackgroundGraphicPositionType = {
/**
* Top left.
*/
TOP_LEFT,
/**
* Top center.
*/
TOP_CENTER,
/**
* Top right.
*/
TOP_RIGHT,
/**
* Center left.
*/
CENTER_LEFT,
/**
* Center.
*/
CENTER_CENTER,
/**
* Center right.
*/
CENTER_RIGHT,
/**
* Bottom left.
*/
BOTTOM_LEFT,
/**
* Bottom center.
*/
BOTTOM_CENTER,
/**
* Bottom right.
*/
BOTTOM_RIGHT,
}
/**
* Utility class containing constants.
* Represents the type of formatting page background with image.
* @enum {number}
*/
const OdsPageBackgroundGraphicType = {
/**
* Set the image at specific position.
*/
POSITION,
/**
* Stretch the image.
*/
AREA,
/**
* Repeat and repeat the image.
*/
TILE,
}
/**
* Utility class containing constants.
* Represents the page background type of ods.
* @enum {number}
*/
const OdsPageBackgroundType = {
/**
* No background.
*/
NONE,
/**
* Formats the background with color.
*/
COLOR,
/**
* Formats the background with image.
*/
GRAPHIC,
}
/**
* Utility class containing constants.
* Specifies the OLE DB command type.
* @enum {number}
*/
const OLEDBCommandType = {
/**
* The command type is not specified.
*/
NONE,
/**
* Specifies a cube name
* unsupported
*/
CUBE_NAME,
/**
* Specifies a SQL statement
*/
SQL_STATEMENT,
/**
* Specifies a table name
*/
TABLE_NAME,
/**
* Specifies that default information has been given, and it is up to the provider how to interpret.
* unsupported
*/
DEFAULT_INFORMATION,
/**
* Specifies a query which is against a web based List Data Provider.
* unsupported
*/
WEB_BASED_LIST,
}
/**
* Utility class containing constants.
* Allows to specify which OOXML specification will be used when saving in the Xlsx format.
* @enum {number}
*/
const OoxmlCompliance = {
/**
* ECMA-376 1st Edition, 2006.
*/
ECMA_376_2006,
/**
* ISO/IEC 29500:2008 Strict compliance level.
*/
ISO_29500_2008_STRICT,
}
/**
* Utility class containing constants.
* The Ooxml compression type
* @enum {number}
*/
const OoxmlCompressionType = {
/**
* The fastest but least effective compression.
*/
LEVEL_1,
/**
* A little slower, but better, than level 1.
*/
LEVEL_2,
/**
* A little slower, but better, than level 2.
*/
LEVEL_3,
/**
* A little slower, but better, than level 3.
*/
LEVEL_4,
/**
* A little slower than level 4, but with better compression.
*/
LEVEL_5,
/**
* A good balance of speed and compression efficiency.
*/
LEVEL_6,
/**
* Pretty good compression!
*/
LEVEL_7,
/**
* Better compression than Level7!
*/
LEVEL_8,
/**
* The "best" compression, where best means greatest reduction in size of the input data stream.
* This is also the slowest compression.
*/
LEVEL_9,
}
/**
* Utility class containing constants.
* Open Document Format version type.
* @enum {number}
*/
const OpenDocumentFormatVersionType = {
/**
* None strict.
* 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,
/**
* ODF Version 1.1
*/
ODF_11,
/**
* ODF Version 1.2
*/
ODF_12,
/**
* ODF Version 1.3
*/
ODF_13,
}
/**
* Utility class containing constants.
* Represents the operator type of conditional format and data validation.
* @enum {number}
*/
const OperatorType = {
/**
* Represents Between operator of conditional format and data validation.
*/
BETWEEN,
/**
* Represents Equal operator of conditional format and data validation.
*/
EQUAL,
/**
* Represents GreaterThan operator of conditional format and data validation.
*/
GREATER_THAN,
/**
* Represents GreaterOrEqual operator of conditional format and data validation.
*/
GREATER_OR_EQUAL,
/**
* Represents LessThan operator of conditional format and data validation.
*/
LESS_THAN,
/**
* Represents LessOrEqual operator of conditional format and data validation.
*/
LESS_OR_EQUAL,
/**
* Represents no comparison.
*/
NONE,
/**
* Represents NotBetween operator of conditional format and data validation.
*/
NOT_BETWEEN,
/**
* Represents NotEqual operator of conditional format and data validation.
*/
NOT_EQUAL,
}
/**
* Utility class containing constants.
* Enumerates page layout alignment types.
* @enum {number}
*/
const PageLayoutAlignmentType = {
/**
* Represents bottom page layout alignment.
*/
BOTTOM,
/**
* Represents center page layout alignment.
*/
CENTER,
/**
* Represents left page layout alignment.
*/
LEFT,
/**
* Represents right page layout alignment.
*/
RIGHT,
/**
* Represents top page layout alignment.
*/
TOP,
}
/**
* Utility class containing constants.
* Represents print orientation constants.
* @enum {number}
*/
const PageOrientationType = {
/**
* Landscape orientation
*/
LANDSCAPE,
/**
* Portrait orientation
*/
PORTRAIT,
}
/**
* Utility class containing constants.
* Represents state of the sheet's pane.
* @enum {number}
*/
const PaneStateType = {
/**
* Panes are frozen, but were not before being frozen.
*/
FROZEN,
/**
* Panes are frozen and were split before being frozen.
*/
FROZEN_SPLIT,
/**
* Panes are split, but not frozen.
*/
SPLIT,
/**
* Panes are not frozen and not split.
*/
NORMAL,
}
/**
* Utility class containing constants.
* Represents paper size constants.
* @enum {number}
*/
const PaperSizeType = {
/**
* Letter (8-1/2 in. x 11 in.)
*/
PAPER_LETTER,
/**
* Letter Small (8-1/2 in. x 11 in.)
*/
PAPER_LETTER_SMALL,
/**
* Tabloid (11 in. x 17 in.)
*/
PAPER_TABLOID,
/**
* Ledger (17 in. x 11 in.)
*/
PAPER_LEDGER,
/**
* Legal (8-1/2 in. x 14 in.)
*/
PAPER_LEGAL,
/**
* Statement (5-1/2 in. x 8-1/2 in.)
*/
PAPER_STATEMENT,
/**
* Executive (7-1/4 in. x 10-1/2 in.)
*/
PAPER_EXECUTIVE,
/**
* A3 (297 mm x 420 mm)
*/
PAPER_A_3,
/**
* A4 (210 mm x 297 mm)
*/
PAPER_A_4,
/**
* A4 Small (210 mm x 297 mm)
*/
PAPER_A_4_SMALL,
/**
* A5 (148 mm x 210 mm)
*/
PAPER_A_5,
/**
* JIS B4 (257 mm x 364 mm)
*/
PAPER_B_4,
/**
* JIS B5 (182 mm x 257 mm)
*/
PAPER_B_5,
/**
* Folio (8-1/2 in. x 13 in.)
*/
PAPER_FOLIO,
/**
* Quarto (215 mm x 275 mm)
*/
PAPER_QUARTO,
/**
* 10 in. x 14 in.
*/
PAPER_10_X_14,
/**
* 11 in. x 17 in.
*/
PAPER_11_X_17,
/**
* Note (8-1/2 in. x 11 in.)
*/
PAPER_NOTE,
/**
* Envelope #9 (3-7/8 in. x 8-7/8 in.)
*/
PAPER_ENVELOPE_9,
/**
* Envelope #10 (4-1/8 in. x 9-1/2 in.)
*/
PAPER_ENVELOPE_10,
/**
* Envelope #11 (4-1/2 in. x 10-3/8 in.)
*/
PAPER_ENVELOPE_11,
/**
* Envelope #12 (4-1/2 in. x 11 in.)
*/
PAPER_ENVELOPE_12,
/**
* Envelope #14 (5 in. x 11-1/2 in.)
*/
PAPER_ENVELOPE_14,
/**
* C size sheet
*/
PAPER_C_SHEET,
/**
* D size sheet
*/
PAPER_D_SHEET,
/**
* E size sheet
*/
PAPER_E_SHEET,
/**
* Envelope DL (110 mm x 220 mm)
*/
PAPER_ENVELOPE_DL,
/**
* Envelope C5 (162 mm x 229 mm)
*/
PAPER_ENVELOPE_C_5,
/**
* Envelope C3 (324 mm x 458 mm)
*/
PAPER_ENVELOPE_C_3,
/**
* Envelope C4 (229 mm x 324 mm)
*/
PAPER_ENVELOPE_C_4,
/**
* Envelope C6 (114 mm x 162 mm)
*/
PAPER_ENVELOPE_C_6,
/**
* Envelope C65 (114 mm x 229 mm)
*/
PAPER_ENVELOPE_C_65,
/**
* Envelope B4 (250 mm x 353 mm)
*/
PAPER_ENVELOPE_B_4,
/**
* Envelope B5 (176 mm x 250 mm)
*/
PAPER_ENVELOPE_B_5,
/**
* Envelope B6 (176 mm x 125 mm)
*/
PAPER_ENVELOPE_B_6,
/**
* Envelope Italy (110 mm x 230 mm)
*/
PAPER_ENVELOPE_ITALY,
/**
* Envelope Monarch (3-7/8 in. x 7-1/2 in.)
*/
PAPER_ENVELOPE_MONARCH,
/**
* Envelope (3-5/8 in. x 6-1/2 in.)
*/
PAPER_ENVELOPE_PERSONAL,
/**
* U.S. Standard Fanfold (14-7/8 in. x 11 in.)
*/
PAPER_FANFOLD_US,
/**
* German Standard Fanfold (8-1/2 in. x 12 in.)
*/
PAPER_FANFOLD_STD_GERMAN,
/**
* German Legal Fanfold (8-1/2 in. x 13 in.)
*/
PAPER_FANFOLD_LEGAL_GERMAN,
/**
* B4 (ISO) 250 x 353 mm
*/
PAPER_ISOB_4,
/**
* Japanese Postcard (100mm × 148mm)
*/
PAPER_JAPANESE_POSTCARD,
/**
* 9? × 11?
*/
PAPER_9_X_11,
/**
* 10? × 11?
*/
PAPER_10_X_11,
/**
* 15? × 11?
*/
PAPER_15_X_11,
/**
* Envelope Invite(220mm × 220mm)
*/
PAPER_ENVELOPE_INVITE,
/**
* US Letter Extra 9 \275 x 12 in
*/
PAPER_LETTER_EXTRA,
/**
* US Legal Extra 9 \275 x 15 in
*/
PAPER_LEGAL_EXTRA,
/**
* US Tabloid Extra 11.69 x 18 in
*/
PAPER_TABLOID_EXTRA,
/**
* A4 Extra 9.27 x 12.69 in
*/
PAPER_A_4_EXTRA,
/**
* Letter Transverse 8 \275 x 11 in
*/
PAPER_LETTER_TRANSVERSE,
/**
* A4 Transverse 210 x 297 mm
*/
PAPER_A_4_TRANSVERSE,
/**
* Letter Extra Transverse 9\275 x 12 in
*/
PAPER_LETTER_EXTRA_TRANSVERSE,
/**
* SuperA/SuperA/A4 227 x 356 mm
*/
PAPER_SUPER_A,
/**
* SuperB/SuperB/A3 305 x 487 mm
*/
PAPER_SUPER_B,
/**
* US Letter Plus 8.5 x 12.69 in
*/
PAPER_LETTER_PLUS,
/**
* A4 Plus 210 x 330 mm
*/
PAPER_A_4_PLUS,
/**
* A5 Transverse 148 x 210 mm
*/
PAPER_A_5_TRANSVERSE,
/**
* B5 (JIS) Transverse 182 x 257 mm
*/
PAPER_JISB_5_TRANSVERSE,
/**
* A3 Extra 322 x 445 mm
*/
PAPER_A_3_EXTRA,
/**
* A5 Extra 174 x 235 mm
*/
PAPER_A_5_EXTRA,
/**
* B5 (ISO) Extra 201 x 276 mm
*/
PAPER_ISOB_5_EXTRA,
/**
* A2 420 x 594 mm
*/
PAPER_A_2,
/**
* A3 Transverse 297 x 420 mm
*/
PAPER_A_3_TRANSVERSE,
/**
* A3 Extra Transverse 322 x 445 mm
*/
PAPER_A_3_EXTRA_TRANSVERSE,
/**
* Japanese Double Postcard 200 x 148 mm
*/
PAPER_JAPANESE_DOUBLE_POSTCARD,
/**
* A6 105 x 148 mm
*/
PAPER_A_6,
/**
* Japanese Envelope Kaku #2
*/
PAPER_JAPANESE_ENVELOPE_KAKU_2,
/**
* Japanese Envelope Kaku #3
*/
PAPER_JAPANESE_ENVELOPE_KAKU_3,
/**
* Japanese Envelope Chou #3
*/
PAPER_JAPANESE_ENVELOPE_CHOU_3,
/**
* Japanese Envelope Chou #4
*/
PAPER_JAPANESE_ENVELOPE_CHOU_4,
/**
* 11in × 8.5in
*/
PAPER_LETTER_ROTATED,
/**
* 420mm × 297mm
*/
PAPER_A_3_ROTATED,
/**
* 297mm × 210mm
*/
PAPER_A_4_ROTATED,
/**
* 210mm × 148mm
*/
PAPER_A_5_ROTATED,
/**
* B4 (JIS) Rotated 364 x 257 mm
*/
PAPER_JISB_4_ROTATED,
/**
* B5 (JIS) Rotated 257 x 182 mm
*/
PAPER_JISB_5_ROTATED,
/**
* Japanese Postcard Rotated 148 x 100 mm
*/
PAPER_JAPANESE_POSTCARD_ROTATED,
/**
* Double Japanese Postcard Rotated 148 x 200 mm
*/
PAPER_JAPANESE_DOUBLE_POSTCARD_ROTATED,
/**
* A6 Rotated 148 x 105 mm
*/
PAPER_A_6_ROTATED,
/**
* Japanese Envelope Kaku #2 Rotated
*/
PAPER_JAPANESE_ENVELOPE_KAKU_2_ROTATED,
/**
* Japanese Envelope Kaku #3 Rotated
*/
PAPER_JAPANESE_ENVELOPE_KAKU_3_ROTATED,
/**
* Japanese Envelope Chou #3 Rotated
*/
PAPER_JAPANESE_ENVELOPE_CHOU_3_ROTATED,
/**
* Japanese Envelope Chou #4 Rotated
*/
PAPER_JAPANESE_ENVELOPE_CHOU_4_ROTATED,
/**
* B6 (JIS) 128 x 182 mm
*/
PAPER_JISB_6,
/**
* B6 (JIS) Rotated 182 x 128 mm
*/
PAPER_JISB_6_ROTATED,
/**
* 12 x 11 in
*/
PAPER_12_X_11,
/**
* Japanese Envelope You #4
*/
PAPER_JAPANESE_ENVELOPE_YOU_4,
/**
* Japanese Envelope You #4 Rotated
*/
PAPER_JAPANESE_ENVELOPE_YOU_4_ROTATED,
/**
* PRC 16K 146 x 215 mm
*/
PAPER_PRC_16_K,
/**
* PRC 32K 97 x 151 mm
*/
PAPER_PRC_32_K,
/**
* PRC 32K(Big) 97 x 151 mm
*/
PAPER_PRC_BIG_32_K,
/**
* PRC Envelope #1 102 x 165 mm
*/
PAPER_PRC_ENVELOPE_1,
/**
* PRC Envelope #2 102 x 176 mm
*/
PAPER_PRC_ENVELOPE_2,
/**
* PRC Envelope #3 125 x 176 mm
*/
PAPER_PRC_ENVELOPE_3,
/**
* PRC Envelope #4 110 x 208 mm
*/
PAPER_PRC_ENVELOPE_4,
/**
* PRC Envelope #5 110 x 220 mm
*/
PAPER_PRC_ENVELOPE_5,
/**
* PRC Envelope #6 120 x 230 mm
*/
PAPER_PRC_ENVELOPE_6,
/**
* PRC Envelope #7 160 x 230 mm
*/
PAPER_PRC_ENVELOPE_7,
/**
* PRC Envelope #8 120 x 309 mm
*/
PAPER_PRC_ENVELOPE_8,
/**
* PRC Envelope #9 229 x 324 mm
*/
PAPER_PRC_ENVELOPE_9,
/**
* PRC Envelope #10 324 x 458 mm
*/
PAPER_PRC_ENVELOPE_10,
/**
* PRC 16K Rotated
*/
PAPER_PRC_16_K_ROTATED,
/**
* PRC 32K Rotated
*/
PAPER_PRC_32_K_ROTATED,
/**
* PRC 32K(Big) Rotated
*/
PAPER_PRC_BIG_32_K_ROTATED,
/**
* PRC Envelope #1 Rotated 165 x 102 mm
*/
PAPER_PRC_ENVELOPE_1_ROTATED,
/**
* PRC Envelope #2 Rotated 176 x 102 mm
*/
PAPER_PRC_ENVELOPE_2_ROTATED,
/**
* PRC Envelope #3 Rotated 176 x 125 mm
*/
PAPER_PRC_ENVELOPE_3_ROTATED,
/**
* PRC Envelope #4 Rotated 208 x 110 mm
*/
PAPER_PRC_ENVELOPE_4_ROTATED,
/**
* PRC Envelope #5 Rotated 220 x 110 mm
*/
PAPER_PRC_ENVELOPE_5_ROTATED,
/**
* PRC Envelope #6 Rotated 230 x 120 mm
*/
PAPER_PRC_ENVELOPE_6_ROTATED,
/**
* PRC Envelope #7 Rotated 230 x 160 mm
*/
PAPER_PRC_ENVELOPE_7_ROTATED,
/**
* PRC Envelope #8 Rotated 309 x 120 mm
*/
PAPER_PRC_ENVELOPE_8_ROTATED,
/**
* PRC Envelope #9 Rotated 324 x 229 mm
*/
PAPER_PRC_ENVELOPE_9_ROTATED,
/**
* PRC Envelope #10 Rotated 458 x 324 mm
*/
PAPER_PRC_ENVELOPE_10_ROTATED,
/**
* usual B3(13.9 x 19.7 in)
*/
PAPER_B_3,
/**
* Business Card(90mm x 55 mm)
*/
PAPER_BUSINESS_CARD,
/**
* Thermal(3 x 11 in)
*/
PAPER_THERMAL,
/**
* Represents the custom paper size.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents all parameters' type or return value type of function.
* @enum {number}
*/
const ParameterType = {
/**
*/
REFERENCE,
/**
*/
VALUE,
/**
*/
ARRAY,
}
/**
* Utility class containing constants.
* Represents operation type when pasting range.
* @enum {number}
*/
const PasteOperationType = {
/**
* No operation.
*/
NONE,
/**
* Add
*/
ADD,
/**
* Subtract
*/
SUBTRACT,
/**
* Multiply
*/
MULTIPLY,
/**
* Divide
*/
DIVIDE,
}
/**
* Utility class containing constants.
* Represents the paste special type.
* @enum {number}
*/
const PasteType = {
/**
* Copies all data of the range.
*/
ALL,
/**
* It works as "All" behavior of MS Excel.
*/
DEFAULT,
/**
* Copies all data of the range without the range.
*/
ALL_EXCEPT_BORDERS,
/**
* It works as "All except borders" behavior of MS Excel.
*/
DEFAULT_EXCEPT_BORDERS,
/**
* Only copies the widths of the range.
*/
COLUMN_WIDTHS,
/**
* Only copies the heights of the range.
*/
ROW_HEIGHTS,
/**
*/
COMMENTS,
/**
*/
FORMATS,
/**
*/
FORMULAS,
/**
*/
FORMULAS_AND_NUMBER_FORMATS,
/**
*/
VALIDATION,
/**
*/
VALUES,
/**
*/
VALUES_AND_FORMATS,
/**
*/
VALUES_AND_NUMBER_FORMATS,
}
/**
* Utility class containing constants.
* Allowing user to set PDF conversion's Compatibility
* @enum {number}
*/
const PdfCompliance = {
/**
* Pdf format compatible with PDF 1.4
* NOTE: This member is now obsolete. Instead,
* please use PDF_14 property.
* This property will be removed 6 months later since November 2023.
* Aspose apologizes for any inconvenience you may have experienced.
*/
NONE,
/**
* Pdf format compatible with PDF 1.4
*/
PDF_14,
/**
* Pdf format compatible with PDF 1.5
*/
PDF_15,
/**
* Pdf format compatible with PDF 1.6
*/
PDF_16,
/**
* Pdf format compatible with PDF 1.7
*/
PDF_17,
/**
* Pdf format compatible with PDF/A-1b(ISO 19005-1)
*/
PDF_A_1_B,
/**
* Pdf format compatible with PDF/A-1a(ISO 19005-1)
*/
PDF_A_1_A,
/**
* Pdf format compatible with PDF/A-2b(ISO 19005-2)
*/
PDF_A_2_B,
/**
* Pdf format compatible with PDF/A-2u(ISO 19005-2)
*/
PDF_A_2_U,
/**
* Pdf format compatible with PDF/A-2a(ISO 19005-2)
*/
PDF_A_2_A,
/**
* Pdf format compatible with PDF/A-3b(ISO 19005-3)
*/
PDF_A_3_B,
/**
* Pdf format compatible with PDF/A-3u(ISO 19005-3)
*/
PDF_A_3_U,
/**
* Pdf format compatible with PDF/A-3a(ISO 19005-3)
*/
PDF_A_3_A,
}
/**
* Utility class containing constants.
* Specifies a type of compression applied to all content in the PDF file except images.
* @enum {number}
*/
const PdfCompressionCore = {
/**
* None
*/
NONE,
/**
* Rle
*/
RLE,
/**
* Lzw
*/
LZW,
/**
* Flate
*/
FLATE,
}
/**
* Utility class containing constants.
* Specifies the way CustomDocumentPropertyCollection are exported to PDF file.
* @enum {number}
*/
const PdfCustomPropertiesExport = {
/**
* No custom properties are exported.
*/
NONE,
/**
* Custom properties are exported as entries in Info dictionary.
* Custom properties with the following names are not exported:
* "Title", "Author", "Subject", "Keywords", "Creator", "Producer", "CreationDate", "ModDate", "Trapped".
*/
STANDARD,
}
/**
* Utility class containing constants.
* Represents pdf embedded font encoding.
* @enum {number}
*/
const PdfFontEncoding = {
/**
* Represents use Identity-H encoding for all embedded fonts in pdf.
*/
IDENTITY,
/**
* Represents prefer to use WinAnsiEncoding for TrueType fonts with characters 32-127,
* otherwise, Identity-H encoding will be used for embedded fonts in pdf.
*/
ANSI_PREFER,
}
/**
* Utility class containing constants.
* Specifies a type of optimization.
* @enum {number}
*/
const PdfOptimizationType = {
/**
* High print quality
*/
STANDARD,
/**
* File size is more important than print quality
* Font Arial and Times New Roman with characters 32-127 will not be embedded in pdf.
* Border lines are optimized for smaller file size.
*/
MINIMUM_SIZE,
}
/**
* Utility class containing constants.
* Indicates the type of rule being used to describe an area or aspect of the PivotTable.
* @enum {number}
*/
const PivotAreaType = {
/**
* No Pivot area.
*/
NONE,
/**
* Represents a header or item.
*/
NORMAL,
/**
* Represents something in the data area.
*/
DATA,
/**
* Represents the whole PivotTable.
*/
ALL,
/**
* Represents the blank cells at the top-left of the PivotTable (top-right for RTL sheets).
*/
ORIGIN,
/**
* Represents a field button.
*/
BUTTON,
/**
* Represents the blank cells at the top-right of the PivotTable (top-left for RTL sheets).
*/
TOP_RIGHT,
}
/**
* Utility class containing constants.
* Represents PivotTable condition formatting rule type.
* @enum {number}
*/
const PivotConditionFormatRuleType = {
/**
* Indicates that Top N conditional formatting is not evaluated
*/
NONE,
/**
* Indicates that Top N conditional formatting is
* evaluated across the entire scope range.
*/
ALL,
/**
* Indicates that Top N conditional formatting is evaluated for each row.
*/
ROW,
/**
* Indicates that Top N conditional formatting is
* evaluated for each column.
*/
COLUMN,
}
/**
* Utility class containing constants.
* Represents PivotTable condition formatting scope type.
* @enum {number}
*/
const PivotConditionFormatScopeType = {
/**
* Indicates that conditional formatting is applied to the selected data fields.
*/
DATA,
/**
* Indicates that conditional formatting is applied to the selected PivotTable field intersections.
*/
FIELD,
/**
* Indicates that conditional formatting is applied to the selected cells.
*/
SELECTION,
}
/**
* Utility class containing constants.
* Represents data display format in the PivotTable data field.
* @enum {number}
*/
const PivotFieldDataDisplayFormat = {
/**
* Represents normal display format.
*/
NORMAL,
/**
* Represents difference from display format.
*/
DIFFERENCE_FROM,
/**
* Represents percentage of display format.
*/
PERCENTAGE_OF,
/**
* Represents percentage difference from display format.
*/
PERCENTAGE_DIFFERENCE_FROM,
/**
* Represents running total in display format.
*/
RUNNING_TOTAL_IN,
/**
* Represents percentage of row display format.
*/
PERCENTAGE_OF_ROW,
/**
* Represents percentage of column display format.
*/
PERCENTAGE_OF_COLUMN,
/**
* Represents percentage of total display format.
*/
PERCENTAGE_OF_TOTAL,
/**
* Represents index display format.
*/
INDEX,
/**
* Represents percentage of parent row total display format.
*/
PERCENTAGE_OF_PARENT_ROW_TOTAL,
/**
* Represents percentage of parent column total display format.
*/
PERCENTAGE_OF_PARENT_COLUMN_TOTAL,
/**
* Represents percentage of parent total display format.
*/
PERCENTAGE_OF_PARENT_TOTAL,
/**
* Represents percentage of running total in display format.
*/
PERCENTAGE_OF_RUNNING_TOTAL_IN,
/**
* Represents smallest to largest display format.
*/
RANK_SMALLEST_TO_LARGEST,
/**
* Represents largest to smallest display format.
*/
RANK_LARGEST_TO_SMALLEST,
}
/**
* Utility class containing constants.
* Represents the group type of pivot field.
* @enum {number}
*/
const PivotFieldGroupType = {
/**
* No group
*/
NONE,
/**
* Grouped by DateTime range.
*/
DATE_TIME_RANGE,
/**
* Grouped by numberic range.
*/
NUMBERIC_RANGE,
/**
* Grouped by discrete points.
*/
DISCRETE,
}
/**
* Utility class containing constants.
* Summary description for PivotFieldSubtotalType.
* @enum {number}
*/
const PivotFieldSubtotalType = {
/**
* Represents None subtotal type.
*/
NONE,
/**
* Represents Automatic subtotal type.
*/
AUTOMATIC,
/**
* Represents Sum subtotal type.
*/
SUM,
/**
* Represents Count subtotal type.
*/
COUNT,
/**
* Represents Average subtotal type.
*/
AVERAGE,
/**
* Represents Max subtotal type.
*/
MAX,
/**
* Represents Min subtotal type.
*/
MIN,
/**
* Represents Product subtotal type.
*/
PRODUCT,
/**
* Represents Count Nums subtotal type.
*/
COUNT_NUMS,
/**
* Represents Stdev subtotal type.
*/
STDEV,
/**
* Represents Stdevp subtotal type.
*/
STDEVP,
/**
* Represents Var subtotal type.
*/
VAR,
/**
* Represents Varp subtotal type.
*/
VARP,
}
/**
* Utility class containing constants.
* Represents PivotTable field type.
* @enum {number}
*/
const PivotFieldType = {
/**
* Presents base pivot field type.
*/
UNDEFINED,
/**
* Presents row pivot field type.
*/
ROW,
/**
* Presents column pivot field type.
*/
COLUMN,
/**
* Presents page pivot field type.
*/
PAGE,
/**
* Presents data pivot field type.
*/
DATA,
}
/**
* Utility class containing constants.
* Represents PivotTable Filter type.
* @enum {number}
*/
const PivotFilterType = {
/**
* Indicates the "begins with" filter for field captions.
*/
CAPTION_BEGINS_WITH,
/**
* Indicates the "is between" filter for field captions.
*/
CAPTION_BETWEEN,
/**
* Indicates the "contains" filter for field captions.
*/
CAPTION_CONTAINS,
/**
* Indicates the "ends with" filter for field captions.
*/
CAPTION_ENDS_WITH,
/**
* Indicates the "equal" filter for field captions.
*/
CAPTION_EQUAL,
/**
* Indicates the "is greater than" filter for field captions.
*/
CAPTION_GREATER_THAN,
/**
* Indicates the "is greater than or equal to" filter for field captions.
*/
CAPTION_GREATER_THAN_OR_EQUAL,
/**
* Indicates the "is less than" filter for field captions.
*/
CAPTION_LESS_THAN,
/**
* Indicates the "is less than or equal to" filter for field captions.
*/
CAPTION_LESS_THAN_OR_EQUAL,
/**
* Indicates the "does not begin with" filter for field captions.
*/
CAPTION_NOT_BEGINS_WITH,
/**
* Indicates the "is not between" filter for field captions.
*/
CAPTION_NOT_BETWEEN,
/**
* Indicates the "does not contain" filter for field captions.
*/
CAPTION_NOT_CONTAINS,
/**
* Indicates the "does not end with" filter for field captions.
*/
CAPTION_NOT_ENDS_WITH,
/**
* Indicates the "not equal" filter for field captions.
*/
CAPTION_NOT_EQUAL,
/**
* Indicates the "count" filter.
*/
COUNT,
/**
* Indicates the "between" filter for date values.
*/
DATE_BETWEEN,
/**
* Indicates the "equals" filter for date values.
*/
DATE_EQUAL,
/**
* Indicates the "newer than" filter for date values.
*/
DATE_NEWER_THAN,
/**
* Indicates the "newer than or equal to" filter for date values.
*/
DATE_NEWER_THAN_OR_EQUAL,
/**
* Indicates the "not between" filter for date values.
*/
DATE_NOT_BETWEEN,
/**
* Indicates the "does not equal" filter for date values.
*/
DATE_NOT_EQUAL,
/**
* Indicates the "older than" filter for date values.
*/
DATE_OLDER_THAN,
/**
* Indicates the "older than or equal to" filter for date values.
*/
DATE_OLDER_THAN_OR_EQUAL,
/**
* Indicates the "last month" filter for date values.
*/
LAST_MONTH,
/**
* Indicates the "last quarter" filter for date values.
*/
LAST_QUARTER,
/**
* Indicates the "last week" filter for date values.
*/
LAST_WEEK,
/**
* Indicates the "last year" filter for date values.
*/
LAST_YEAR,
/**
* Indicates the "January" filter for date values.
*/
M_1,
/**
* Indicates the "February" filter for date values.
*/
M_2,
/**
* Indicates the "March" filter for date values.
*/
M_3,
/**
* Indicates the "April" filter for date values.
*/
M_4,
/**
* Indicates the "May" filter for date values.
*/
M_5,
/**
* Indicates the "June" filter for date values.
*/
M_6,
/**
* Indicates the "July" filter for date values.
*/
M_7,
/**
* Indicates the "August" filter for date values.
*/
M_8,
/**
* Indicates the "September" filter for date values.
*/
M_9,
/**
* Indicates the "October" filter for date values.
*/
M_10,
/**
* Indicates the "November" filter for date values.
*/
M_11,
/**
* Indicates the "December" filter for date values.
*/
M_12,
/**
* Indicates the "next month" filter for date values.
*/
NEXT_MONTH,
/**
* Indicates the "next quarter" for date values.
*/
NEXT_QUARTER,
/**
* Indicates the "next week" for date values.
*/
NEXT_WEEK,
/**
* Indicates the "next year" filter for date values.
*/
NEXT_YEAR,
/**
* Indicates the "percent" filter for numeric values.
*/
PERCENT,
/**
* Indicates the "first quarter" filter for date values.
*/
Q_1,
/**
* Indicates the "second quarter" filter for date values.
*/
Q_2,
/**
* Indicates the "third quarter" filter for date values.
*/
Q_3,
/**
* Indicates the "fourth quarter" filter for date values.
*/
Q_4,
/**
* Indicates the "sum" filter for numeric values.
*/
SUM,
/**
* Indicates the "this month" filter for date values.
*/
THIS_MONTH,
/**
* Indicates the "this quarter" filter for date values.
*/
THIS_QUARTER,
/**
* Indicates the "this week" filter for date values.
*/
THIS_WEEK,
/**
* Indicate the "this year" filter for date values.
*/
THIS_YEAR,
/**
* Indicates the "today" filter for date values.
*/
TODAY,
/**
* Indicates the "tomorrow" filter for date values.
*/
TOMORROW,
/**
* Indicates the PivotTable filter is unknown to the application.
*/
UNKNOWN,
/**
* Indicates the "Value between" filter for text and numeric values.
*/
VALUE_BETWEEN,
/**
* Indicates the "value equal" filter for text and numeric values.
*/
VALUE_EQUAL,
/**
* Indicates the "value greater than" filter for text and numeric values.
*/
VALUE_GREATER_THAN,
/**
* Indicates the "value greater than or equal to" filter for text and numeric values.
*/
VALUE_GREATER_THAN_OR_EQUAL,
/**
* Indicates the "value less than" filter for text and numeric values.
*/
VALUE_LESS_THAN,
/**
* Indicates the "value less than or equal to" filter for text and numeric values.
*/
VALUE_LESS_THAN_OR_EQUAL,
/**
* Indicates the "value not between" filter for text and numeric values.
*/
VALUE_NOT_BETWEEN,
/**
* Indicates the "value not equal" filter for text and numeric values.
*/
VALUE_NOT_EQUAL,
/**
* Indicates the "year-to-date" filter for date values.
*/
YEAR_TO_DATE,
/**
* Indicates the "yesterday" filter for date values.
*/
YESTERDAY,
}
/**
* Utility class containing constants.
* Represents group by type.
* @enum {number}
*/
const PivotGroupByType = {
/**
* Group by numbers.
* 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.
*/
RANGE_OF_VALUES,
/**
* Group by numbers.
*/
NUMBERS,
/**
* Presents Seconds groupby type.
*/
SECONDS,
/**
* Presents Minutes groupby type.
*/
MINUTES,
/**
* Presents Hours groupby type.
*/
HOURS,
/**
* Presents Days groupby type.
*/
DAYS,
/**
* Presents Months groupby type.
*/
MONTHS,
/**
* Presents Quarters groupby type.
*/
QUARTERS,
/**
* Presents Years groupby type.
*/
YEARS,
}
/**
* Utility class containing constants.
* Represents PivotTable base item Next/Previous/All position in the base field .
* @enum {number}
*/
const PivotItemPosition = {
/**
* Represents the previous pivot item in the PivotField.
*/
PREVIOUS,
/**
* Represents the next pivot item in the PivotField.
*/
NEXT,
/**
* Represents a pivot item index, as specified by Pivot Items, that specifies a pivot item in the PivotField.
* only read
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents number of items to retain per field.
* @enum {number}
*/
const PivotMissingItemLimitType = {
/**
* The default number of unique items per PivotField allowed.
*/
AUTOMATIC,
/**
* The maximum number of unique items per PivotField allowed (>32,500).
*/
MAX,
/**
* No unique items per PivotField allowed.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents PivotTable auto format type.
* @enum {number}
*/
const PivotTableAutoFormatType = {
/**
* Represents None format type.
*/
NONE,
/**
* Represents Classic auto format type.
*/
CLASSIC,
/**
* Represents Report1 format type.
*/
REPORT_1,
/**
* Represents Report2 format type.
*/
REPORT_2,
/**
* Represents Report3 format type.
*/
REPORT_3,
/**
* Represents Report4 format type.
*/
REPORT_4,
/**
* Represents Report5 format type.
*/
REPORT_5,
/**
* Represents Report6 format type.
*/
REPORT_6,
/**
* Represents Report7 format type.
*/
REPORT_7,
/**
* Represents Report8 format type.
*/
REPORT_8,
/**
* Represents Report9 format type.
*/
REPORT_9,
/**
* Represents Report10 format type.
*/
REPORT_10,
/**
* Represents Table1 format type.
*/
TABLE_1,
/**
* Represents Table2 format type.
*/
TABLE_2,
/**
* Represents Table3 format type.
*/
TABLE_3,
/**
* Represents Table4 format type.
*/
TABLE_4,
/**
* Represents Table5 format type.
*/
TABLE_5,
/**
* Represents Table6 format type.
*/
TABLE_6,
/**
* Represents Table7 format type.
*/
TABLE_7,
/**
* Represents Table8 format type.
*/
TABLE_8,
/**
* Represents Table9 format type.
*/
TABLE_9,
/**
* Represents Table10 format type.
*/
TABLE_10,
}
/**
* Utility class containing constants.
* Specifies what can be selected in a PivotTable during a structured selection.
* These constants can be combined to select multiple types.
* @enum {number}
*/
const PivotTableSelectionType = {
/**
* Data and labels
*/
DATA_AND_LABEL,
/**
* Only selects data
*/
DATA_ONLY,
/**
* Only selects labels
*/
LABEL_ONLY,
}
/**
* Utility class containing constants.
* Represents the pivot table style type.
* @enum {number}
*/
const PivotTableStyleType = {
/**
*/
NONE,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_1,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_2,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_3,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_4,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_5,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_6,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_7,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_8,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_9,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_10,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_11,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_12,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_13,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_14,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_15,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_16,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_17,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_18,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_19,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_20,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_21,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_22,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_23,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_24,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_25,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_26,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_27,
/**
*/
PIVOT_TABLE_STYLE_LIGHT_28,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_1,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_2,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_3,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_4,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_5,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_6,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_7,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_8,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_9,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_10,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_11,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_12,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_13,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_14,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_15,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_16,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_17,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_18,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_19,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_20,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_21,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_22,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_23,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_24,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_25,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_26,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_27,
/**
*/
PIVOT_TABLE_STYLE_MEDIUM_28,
/**
*/
PIVOT_TABLE_STYLE_DARK_1,
/**
*/
PIVOT_TABLE_STYLE_DARK_2,
/**
*/
PIVOT_TABLE_STYLE_DARK_3,
/**
*/
PIVOT_TABLE_STYLE_DARK_4,
/**
*/
PIVOT_TABLE_STYLE_DARK_5,
/**
*/
PIVOT_TABLE_STYLE_DARK_6,
/**
*/
PIVOT_TABLE_STYLE_DARK_7,
/**
*/
PIVOT_TABLE_STYLE_DARK_8,
/**
*/
PIVOT_TABLE_STYLE_DARK_9,
/**
*/
PIVOT_TABLE_STYLE_DARK_10,
/**
*/
PIVOT_TABLE_STYLE_DARK_11,
/**
*/
PIVOT_TABLE_STYLE_DARK_12,
/**
*/
PIVOT_TABLE_STYLE_DARK_13,
/**
*/
PIVOT_TABLE_STYLE_DARK_14,
/**
*/
PIVOT_TABLE_STYLE_DARK_15,
/**
*/
PIVOT_TABLE_STYLE_DARK_16,
/**
*/
PIVOT_TABLE_STYLE_DARK_17,
/**
*/
PIVOT_TABLE_STYLE_DARK_18,
/**
*/
PIVOT_TABLE_STYLE_DARK_19,
/**
*/
PIVOT_TABLE_STYLE_DARK_20,
/**
*/
PIVOT_TABLE_STYLE_DARK_21,
/**
*/
PIVOT_TABLE_STYLE_DARK_22,
/**
*/
PIVOT_TABLE_STYLE_DARK_23,
/**
*/
PIVOT_TABLE_STYLE_DARK_24,
/**
*/
PIVOT_TABLE_STYLE_DARK_25,
/**
*/
PIVOT_TABLE_STYLE_DARK_26,
/**
*/
PIVOT_TABLE_STYLE_DARK_27,
/**
*/
PIVOT_TABLE_STYLE_DARK_28,
/**
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the way the drawing object is attached to the cells below it.
* @enum {number}
*/
const PlacementType = {
/**
* Don't move or size with cells.
*/
FREE_FLOATING,
/**
* Move but don't size with cells.
*/
MOVE,
/**
* Move and size with cells.
*/
MOVE_AND_SIZE,
}
/**
* Utility class containing constants.
* Represents the type of data plot by row or column.
* @enum {number}
*/
const PlotDataByType = {
/**
* By row.
*/
ROW,
/**
* By column.
*/
COLUMN,
}
/**
* Utility class containing constants.
* Represents all plot empty cells type of a chart.
* @enum {number}
*/
const PlotEmptyCellsType = {
/**
* Not plotted(leave gap)
*/
NOT_PLOTTED,
/**
* Zero
*/
ZERO,
/**
* Interpolated
*/
INTERPOLATED,
}
/**
* Utility class containing constants.
* Represent different algorithmic methods for setting all camera properties, including position.
* @enum {number}
*/
const PresetCameraType = {
/**
*/
ISOMETRIC_BOTTOM_DOWN,
/**
*/
ISOMETRIC_BOTTOM_UP,
/**
*/
ISOMETRIC_LEFT_DOWN,
/**
*/
ISOMETRIC_LEFT_UP,
/**
*/
ISOMETRIC_OFF_AXIS_1_LEFT,
/**
*/
ISOMETRIC_OFF_AXIS_1_RIGHT,
/**
*/
ISOMETRIC_OFF_AXIS_1_TOP,
/**
*/
ISOMETRIC_OFF_AXIS_2_LEFT,
/**
*/
ISOMETRIC_OFF_AXIS_2_RIGHT,
/**
*/
ISOMETRIC_OFF_AXIS_2_TOP,
/**
*/
ISOMETRIC_OFF_AXIS_3_BOTTOM,
/**
*/
ISOMETRIC_OFF_AXIS_3_LEFT,
/**
*/
ISOMETRIC_OFF_AXIS_3_RIGHT,
/**
*/
ISOMETRIC_OFF_AXIS_4_BOTTOM,
/**
*/
ISOMETRIC_OFF_AXIS_4_LEFT,
/**
*/
ISOMETRIC_OFF_AXIS_4_RIGHT,
/**
*/
ISOMETRIC_RIGHT_DOWN,
/**
*/
ISOMETRIC_RIGHT_UP,
/**
*/
ISOMETRIC_TOP_DOWN,
/**
*/
ISOMETRIC_TOP_UP,
/**
*/
LEGACY_OBLIQUE_BOTTOM,
/**
*/
LEGACY_OBLIQUE_BOTTOM_LEFT,
/**
*/
LEGACY_OBLIQUE_BOTTOM_RIGHT,
/**
*/
LEGACY_OBLIQUE_FRONT,
/**
*/
LEGACY_OBLIQUE_LEFT,
/**
*/
LEGACY_OBLIQUE_RIGHT,
/**
*/
LEGACY_OBLIQUE_TOP,
/**
*/
LEGACY_OBLIQUE_TOP_LEFT,
/**
*/
LEGACY_OBLIQUE_TOP_RIGHT,
/**
*/
LEGACY_PERSPECTIVE_BOTTOM,
/**
*/
LEGACY_PERSPECTIVE_BOTTOM_LEFT,
/**
*/
LEGACY_PERSPECTIVE_BOTTOM_RIGHT,
/**
*/
LEGACY_PERSPECTIVE_FRONT,
/**
*/
LEGACY_PERSPECTIVE_LEFT,
/**
*/
LEGACY_PERSPECTIVE_RIGHT,
/**
*/
LEGACY_PERSPECTIVE_TOP,
/**
*/
LEGACY_PERSPECTIVE_TOP_LEFT,
/**
*/
LEGACY_PERSPECTIVE_TOP_RIGHT,
/**
*/
OBLIQUE_BOTTOM,
/**
*/
OBLIQUE_BOTTOM_LEFT,
/**
*/
OBLIQUE_BOTTOM_RIGHT,
/**
*/
OBLIQUE_LEFT,
/**
*/
OBLIQUE_RIGHT,
/**
*/
OBLIQUE_TOP,
/**
*/
OBLIQUE_TOP_LEFT,
/**
*/
OBLIQUE_TOP_RIGHT,
/**
*/
ORTHOGRAPHIC_FRONT,
/**
*/
PERSPECTIVE_ABOVE,
/**
*/
PERSPECTIVE_ABOVE_LEFT_FACING,
/**
*/
PERSPECTIVE_ABOVE_RIGHT_FACING,
/**
*/
PERSPECTIVE_BELOW,
/**
*/
PERSPECTIVE_CONTRASTING_LEFT_FACING,
/**
*/
PERSPECTIVE_CONTRASTING_RIGHT_FACING,
/**
*/
PERSPECTIVE_FRONT,
/**
*/
PERSPECTIVE_HEROIC_EXTREME_LEFT_FACING,
/**
*/
PERSPECTIVE_HEROIC_EXTREME_RIGHT_FACING,
/**
*/
PERSPECTIVE_HEROIC_LEFT_FACING,
/**
*/
PERSPECTIVE_HEROIC_RIGHT_FACING,
/**
*/
PERSPECTIVE_LEFT,
/**
*/
PERSPECTIVE_RELAXED,
/**
*/
PERSPECTIVE_RELAXED_MODERATELY,
/**
*/
PERSPECTIVE_RIGHT,
}
/**
* Utility class containing constants.
* Describes surface appearance of a shape.
* @enum {number}
*/
const PresetMaterialType = {
/**
* Clear
*/
CLEAR,
/**
* Dark edge
*/
DARK_EDGE,
/**
* Flat
*/
FLAT,
/**
* Legacy matte
*/
LEGACY_MATTE,
/**
* Legacy metal
*/
LEGACY_METAL,
/**
* Legacy plastic
*/
LEGACY_PLASTIC,
/**
* Legacy wireframe
*/
LEGACY_WIREFRAME,
/**
* Matte
*/
MATTE,
/**
* Metal
*/
METAL,
/**
* Plastic
*/
PLASTIC,
/**
* Powder
*/
POWDER,
/**
* Soft edge
*/
SOFT_EDGE,
/**
* Soft metal
*/
SOFT_METAL,
/**
* Translucent powder
*/
TRANSLUCENT_POWDER,
/**
* Warm matte
*/
WARM_MATTE,
}
/**
* Utility class containing constants.
* Represents preset shadow type.
* @enum {number}
*/
const PresetShadowType = {
/**
* No shadow.
*/
NO_SHADOW,
/**
* Custom shadow.
*/
CUSTOM,
/**
* Outer shadow offset diagonal bottom right.
*/
OFFSET_DIAGONAL_BOTTOM_RIGHT,
/**
* Outer shadow offset bottom.
*/
OFFSET_BOTTOM,
/**
* Outer shadow offset diagonal bottom left.
*/
OFFSET_DIAGONAL_BOTTOM_LEFT,
/**
* Outer shadow offset right.
*/
OFFSET_RIGHT,
/**
* Outer shadow offset center.
*/
OFFSET_CENTER,
/**
* Outer shadow offset left.
*/
OFFSET_LEFT,
/**
* Outer shadow offset diagonal top right.
*/
OFFSET_DIAGONAL_TOP_RIGHT,
/**
* Outer shadow offset top.
*/
OFFSET_TOP,
/**
* Outer shadow offset diagonal top left.
*/
OFFSET_DIAGONAL_TOP_LEFT,
/**
* Inner shadow inside diagonal top Left.
*/
INSIDE_DIAGONAL_TOP_LEFT,
/**
* Inner shadow inside top.
*/
INSIDE_TOP,
/**
* Inner shadow inside diagonal top right.
*/
INSIDE_DIAGONAL_TOP_RIGHT,
/**
* Inner shadow inside left.
*/
INSIDE_LEFT,
/**
* Inner shadow inside center.
*/
INSIDE_CENTER,
/**
* Inner shadow inside right.
*/
INSIDE_RIGHT,
/**
* Inner shadow inside diagonal bottom left.
*/
INSIDE_DIAGONAL_BOTTOM_LEFT,
/**
* Inner shadow inside bottom.
*/
INSIDE_BOTTOM,
/**
* Inner shadow inside diagonal bottom right.
*/
INSIDE_DIAGONAL_BOTTOM_RIGHT,
/**
* Outer shadow perspective diagonal upper left.
*/
PERSPECTIVE_DIAGONAL_UPPER_LEFT,
/**
* Outer shadow perspective diagonal upper right.
*/
PERSPECTIVE_DIAGONAL_UPPER_RIGHT,
/**
* Outer shadow below.
*/
BELOW,
/**
* Outer shadow perspective diagonal lower left.
*/
PERSPECTIVE_DIAGONAL_LOWER_LEFT,
/**
* Outer shadow perspective diagonal lower right.
*/
PERSPECTIVE_DIAGONAL_LOWER_RIGHT,
}
/**
* Utility class containing constants.
* Represents the preset theme gradient type.
* @enum {number}
*/
const PresetThemeGradientType = {
/**
* Light gradient
*/
LIGHT_GRADIENT,
/**
* Top spotlight
*/
TOP_SPOTLIGHT,
/**
* Medium gradient
*/
MEDIUM_GRADIENT,
/**
* Bottom spotlight
*/
BOTTOM_SPOTLIGHT,
/**
* Radial gradient
*/
RADIAL_GRADIENT,
}
/**
* Utility class containing constants.
* Represents the preset WordArt styles.
* @enum {number}
*/
const PresetWordArtStyle = {
/**
* Fill - Black, Text 1, Shadow
*/
WORD_ART_STYLE_1,
/**
* Fill - Blue, Accent 1, Shadow
*/
WORD_ART_STYLE_2,
/**
* Fill - Orange, Accent 2, Outline - Accent 2
*/
WORD_ART_STYLE_3,
/**
* Fill - White, Outline - Accent 1, Shadow
*/
WORD_ART_STYLE_4,
/**
* Fill - Gold, Accent 4, Soft Bevel
*/
WORD_ART_STYLE_5,
/**
* Gradient Fill - Gray
*/
WORD_ART_STYLE_6,
/**
* Gradient Fill - Blue, Accent 1, Reflection
*/
WORD_ART_STYLE_7,
/**
* Gradient Fill - Gold, Accent 4, Outline - Accent 4
*/
WORD_ART_STYLE_8,
/**
* Fill - White, Outline - Accent 1, Glow - Accent 1
*/
WORD_ART_STYLE_9,
/**
* Fill - Gray-50%, Accent 3, Sharp Bevel
*/
WORD_ART_STYLE_10,
/**
* Fill - Black, Text 1, Outline - Background 1, Hard Shadow - Background 1
*/
WORD_ART_STYLE_11,
/**
* Fill - Black, Text 1, Outline - Background 1, Hard Shadow - Accent 1
*/
WORD_ART_STYLE_12,
/**
* Fill - Blue, Accent 1, Outline - Background 1, Hard Shadow - Accent 1
*/
WORD_ART_STYLE_13,
/**
* Fill - White, Outline - Accent 2, Hard Shadow - Accent 2
*/
WORD_ART_STYLE_14,
/**
* Fill - Gray-25%, Background 2, Inner Shadow
*/
WORD_ART_STYLE_15,
/**
* Pattern Fill - White, Text 2, Dark Upward Diagonal, Shadow
*/
WORD_ART_STYLE_16,
/**
* Pattern Fill - Gray-50%, Accent 3, Narrow Horizontal, Inner Shadow
*/
WORD_ART_STYLE_17,
/**
* Fill - Blue, Accent 1, 50%, Hard Shadow - Accent 1
*/
WORD_ART_STYLE_18,
/**
* Pattern Fill - Blue, Accent 1, Light Downward Diagonal, Outline - Accent 1
*/
WORD_ART_STYLE_19,
/**
* Pattern Fill - Blue-Gray, Text 2, Dark Upward Diagonal, Hard Shadow - Text 2
*/
WORD_ART_STYLE_20,
}
/**
* Utility class containing constants.
* Represents the way comments are printed with the sheet.
* @enum {number}
*/
const PrintCommentsType = {
/**
* Represents to print comments as displayed on sheet.
*/
PRINT_IN_PLACE,
/**
* Represents not to print comments.
*/
PRINT_NO_COMMENTS,
/**
* Represents to print comments at end of sheet.
*/
PRINT_SHEET_END,
}
/**
* Utility class containing constants.
* Represents print errors constants.
* @enum {number}
*/
const PrintErrorsType = {
/**
* Represents not to print errors.
*/
PRINT_ERRORS_BLANK,
/**
* Represents to print errors as "--".
*/
PRINT_ERRORS_DASH,
/**
* Represents to print errors as displayed.
*/
PRINT_ERRORS_DISPLAYED,
/**
* Represents to print errors as "#N/A".
*/
PRINT_ERRORS_NA,
}
/**
* Utility class containing constants.
* Indicates which pages will not be printed.
* @enum {number}
*/
const PrintingPageType = {
/**
* Prints all pages.
*/
DEFAULT,
/**
* Don't print the pages which the cells are blank.
*/
IGNORE_BLANK,
/**
* Don't print the pages which cells only contain styles.
*/
IGNORE_STYLE,
}
/**
* Utility class containing constants.
* Represent print order constants.
* @enum {number}
*/
const PrintOrderType = {
/**
* Down, then over
*/
DOWN_THEN_OVER,
/**
* Over, then down
*/
OVER_THEN_DOWN,
}
/**
* Utility class containing constants.
* Represents the printed chart size.
* @enum {number}
*/
const PrintSizeType = {
/**
* Use full page.
*/
FULL,
/**
* Scale to fit page.
*/
FIT,
/**
* Custom.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Specifies data type of a document property.
* @enum {number}
*/
const PropertyType = {
/**
* The property is a boolean value.
*/
BOOLEAN,
/**
* The property is a date time value.
*/
DATE_TIME,
/**
* The property is a floating number.
*/
DOUBLE,
/**
* The property is an integer number.
*/
NUMBER,
/**
* The property is a string value.
*/
STRING,
/**
* The property is a byte array.
*/
BLOB,
}
/**
* Utility class containing constants.
* Represents workbook/worksheet protection type.
* @enum {number}
*/
const ProtectionType = {
/**
* Represents to protect all.
*/
ALL,
/**
* Represents to protect contents, used in Worksheet protection.
*/
CONTENTS,
/**
* Represents to protect objects, used in Worksheet protection.
*/
OBJECTS,
/**
* Represents to protect scenarios, used in Worksheet protection.
*/
SCENARIOS,
/**
* Represents to protect structure, used in Workbook protection.
*/
STRUCTURE,
/**
* Represents to protect window, used in Workbook protection.
*/
WINDOWS,
/**
* Represents no protection. Only for Reading property.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents quartile calculation methods.
* @enum {number}
*/
const QuartileCalculationType = {
/**
* The quartile calculation includes the median when splitting the dataset into quartiles.
*/
EXCLUSIVE,
/**
* The quartile calculation excludes the median when splitting the dataset into quartiles.
*/
INCLUSIVE,
}
/**
* Utility class containing constants.
* Specifies what the spreadsheet application should do when a connection fails.
* @enum {number}
*/
const 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,
/**
* 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,
/**
* 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,
}
/**
* Utility class containing constants.
* Represents how to position two rectangles relative to each other.
* @enum {number}
*/
const RectangleAlignmentType = {
/**
* Bottom
*/
BOTTOM,
/**
* BottomLeft
*/
BOTTOM_LEFT,
/**
* BottomRight
*/
BOTTOM_RIGHT,
/**
* Center
*/
CENTER,
/**
* Left
*/
LEFT,
/**
* Right
*/
RIGHT,
/**
* Top
*/
TOP,
/**
* TopLeft
*/
TOP_LEFT,
/**
* TopRight
*/
TOP_RIGHT,
}
/**
* Utility class containing constants.
* Represents the effect type of reflection.
* @enum {number}
*/
const ReflectionEffectType = {
/**
* No reflection effect.
*/
NONE,
/**
* Custom reflection effect.
*/
CUSTOM,
/**
* Tight reflection, touching.
*/
TIGHT_REFLECTION_TOUCHING,
/**
* Half reflection, touching.
*/
HALF_REFLECTION_TOUCHING,
/**
* Full reflection, touching.
*/
FULL_REFLECTION_TOUCHING,
/**
* Tight reflection, 4 pt offset.
*/
TIGHT_REFLECTION_4_PT_OFFSET,
/**
* Half reflection, 4 pt offset.
*/
HALF_REFLECTION_4_PT_OFFSET,
/**
* Full reflection, 4 pt offset.
*/
FULL_REFLECTION_4_PT_OFFSET,
/**
* Tight reflection, 8 pt offset.
*/
TIGHT_REFLECTION_8_PT_OFFSET,
/**
* Half reflection, 8 pt offset.
*/
HALF_REFLECTION_8_PT_OFFSET,
/**
* Full reflection, 8 pt offset.
*/
FULL_REFLECTION_8_PT_OFFSET,
}
/**
* Utility class containing constants.
* Strategy option for duplicate names of columns.
* 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.
* @enum {number}
*/
const RenameStrategy = {
/**
* Throws exception.
*/
EXCEPTION,
/**
* Named with digit. Duplicated names will become ...1, ...2, etc.
*/
DIGIT,
/**
* Named with letter.. Duplicated names will become ...A, ...B, etc.
*/
LETTER,
}
/**
* Utility class containing constants.
* Represents how to keep the missing pivot items.
* @enum {number}
*/
const ReserveMissingPivotItemType = {
/**
* Removes old missint pivot items and reserves visible items which the current data source does not contain as missing items.
*/
DEFAULT,
/**
* Reserves all missing items.
*/
ALL,
/**
* Removes all missing pivot items.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents how to loading the linked resource.
* @enum {number}
*/
const ResourceLoadingType = {
/**
* Loads this resource as usual.
*/
DEFAULT,
/**
* Skips loading of this resource.
*/
SKIP,
/**
* Use stream provided by user
*/
USER_PROVIDED,
}
/**
* Utility class containing constants.
* Represents the type of revision action.
* @enum {number}
*/
const RevisionActionType = {
/**
* Add revision.
*/
ADD,
/**
* Delete revision.
*/
DELETE,
/**
* Column delete revision.
*/
DELETE_COLUMN,
/**
* Row delete revision.
*/
DELETE_ROW,
/**
* Column insert revision.
*/
INSERT_COLUMN,
/**
* Row insert revision.
*/
INSERT_ROW,
}
/**
* Utility class containing constants.
* Represents the revision type.
* @enum {number}
*/
const RevisionType = {
/**
* Custom view.
*/
CUSTOM_VIEW,
/**
* Defined name.
*/
DEFINED_NAME,
/**
* Cells change.
*/
CHANGE_CELLS,
/**
* Auto format.
*/
AUTO_FORMAT,
/**
* Merge conflict.
*/
MERGE_CONFLICT,
/**
* Comment.
*/
COMMENT,
/**
* Format.
*/
FORMAT,
/**
* Insert worksheet.
*/
INSERT_SHEET,
/**
* Move cells.
*/
MOVE_CELLS,
/**
* Undo.
*/
UNDO,
/**
* Query table.
*/
QUERY_TABLE,
/**
* Inserting or deleting.
*/
INSERT_DELETE,
/**
* Rename worksheet.
*/
RENAME_SHEET,
/**
* Unknown.
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Represents the format in which the workbook is saved.
* @enum {number}
*/
const SaveFormat = {
/**
* Comma-Separated Values(CSV) text file.
*/
CSV,
/**
* Represents an xlsx file.
*/
XLSX,
/**
* Represents an xlsm file which enable macros.
*/
XLSM,
/**
* Represents an xltx file.
*/
XLTX,
/**
* Represents an xltm file which enable macros.
*/
XLTM,
/**
* Represents an xltm file which enable addin macros.
*/
XLAM,
/**
* Tab-Separated Values(TSV) text file.
*/
TSV,
/**
* Represents a tab delimited text file, same with TSV.
*/
TAB_DELIMITED,
/**
* Represents a html file.
*/
HTML,
/**
* Represents a mhtml file.
*/
M_HTML,
/**
* Open Document Sheet(ODS) file.
*/
ODS,
/**
* Represents an Excel97-2003 xls file.
*/
EXCEL_97_TO_2003,
/**
* Represents an Excel 2003 xml file.
*/
SPREADSHEET_ML,
/**
* Represents an xlsb file.
*/
XLSB,
/**
* 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,
/**
* Represents unrecognized format, cannot be saved.
*/
UNKNOWN,
/**
* Represents a Pdf file.
*/
PDF,
/**
* XPS (XML Paper Specification) format.
*/
XPS,
/**
* Represents a TIFF file.
*/
TIFF,
/**
* SVG file.
*/
SVG,
/**
* Data Interchange Format.
*/
DIF,
/**
* Open Document Template Sheet(OTS) file.
*/
OTS,
/**
* Excel 97-2003 template file.
*/
XLT,
/**
* Represents a simple xml file.
*/
XML,
/**
* Represents a numbers file.
* Not supported.
*/
NUMBERS,
/**
* Represents markdown document.
*/
MARKDOWN,
/**
* Represents OpenDocument Flat XML Spreadsheet (.fods) file format.
*/
FODS,
/**
* Represents StarOffice Calc Spreadsheet (.sxc) file format.
*/
SXC,
/**
* Represents .pptx file.
*/
PPTX,
/**
* Represents .docx file.
*/
DOCX,
/**
* Windows Enhanced Metafile.
*/
EMF,
/**
* JPEG JFIF.
*/
JPG,
/**
* Portable Network Graphics.
*/
PNG,
/**
* Windows Bitmap
*/
BMP,
/**
* Gif
*/
GIF,
/**
* Json
*/
JSON,
/**
* Sql
*/
SQL_SCRIPT,
/**
* Rrepesents XHtml file.
*/
X_HTML,
/**
* Represents Epub file.
*/
EPUB,
}
/**
* Utility class containing constants.
* The selection type of list box.
* @enum {number}
*/
const SelectionType = {
/**
* Sigle selection type.
*/
SINGLE,
/**
* Multiple selection type.
*/
MULTI,
/**
* Extend selection type.
*/
EXTEND,
}
/**
* Utility class containing constants.
* Represents the anchor type.
* @enum {number}
*/
const ShapeAnchorType = {
/**
* Represents a two cell anchor placeholder
*/
TWO_CELL_ANCHOR,
/**
* Represents a one cell anchor placeholder
*/
ONE_CELL_ANCHOR,
}
/**
* Utility class containing constants.
* Represents type of the property to be locked.
* @enum {number}
*/
const ShapeLockType = {
/**
* Group
*/
GROUP,
/**
* AdjustHandles
*/
ADJUST_HANDLES,
/**
* Text
*/
TEXT,
/**
* Points
*/
POINTS,
/**
* Crop
*/
CROP,
/**
* Selection
*/
SELECTION,
/**
* Move
*/
MOVE,
/**
* AspectRatio
*/
ASPECT_RATIO,
/**
* Rotation
*/
ROTATION,
/**
* Ungroup
*/
UNGROUP,
/**
* Resize
*/
RESIZE,
/**
* ShapeType
*/
SHAPE_TYPE,
/**
* Arrowhead
*/
ARROWHEAD,
}
/**
* Utility class containing constants.
* Represents path segment type.
* @enum {number}
*/
const ShapePathType = {
/**
* Straight line segment
*/
LINE_TO,
/**
* Cubic Bezier curve
*/
CUBIC_BEZIER_CURVE_TO,
/**
* Start a new path
*/
MOVE_TO,
/**
* 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,
/**
* The end of the current path
*/
END,
/**
* Escape
*/
ESCAPE,
/**
* An arc
*/
ARC_TO,
/**
* Unknown
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Specifies the worksheet type.
* @enum {number}
*/
const SheetType = {
/**
* Visual Basic module
*/
VB,
/**
*/
WORKSHEET,
/**
* Chart
*/
CHART,
/**
* BIFF4 Macro sheet
*/
BIFF_4_MACRO,
/**
* International Macro sheet
*/
INTERNATIONAL_MACRO,
/**
*/
OTHER,
/**
* Dialog worksheet
*/
DIALOG,
}
/**
* Utility class containing constants.
* Represent the shift options when deleting a range of cells.
* @enum {number}
*/
const ShiftType = {
/**
* Shift cells down.
*/
DOWN,
/**
* Shift cells left.
*/
LEFT,
/**
* Do not shift cells.
*/
NONE,
/**
* Shift cells right.
*/
RIGHT,
/**
* Shift cells up.
*/
UP,
}
/**
* Utility class containing constants.
* Specifies when to show the drop button
* @enum {number}
*/
const ShowDropButtonType = {
/**
* Never show the drop button.
*/
NEVER,
/**
* Show the drop button when the control has the focus.
*/
FOCUS,
/**
* Always show the drop button.
*/
ALWAYS,
}
/**
* Utility class containing constants.
* Represent the type of SlicerCacheCrossFilterType
* @enum {number}
*/
const SlicerCacheCrossFilterType = {
/**
* The table style element of the slicer style for slicer items
* with no data is not applied to slicer items with no data, and slicer items
* with no data are not sorted separately in the list of slicer items in the slicer view
*/
NONE,
/**
* The table style element of the slicer style for slicer items with
* no data is applied to slicer items with no data, and slicer items
* with no data are sorted at the bottom in the list of slicer items in the slicer view
*/
SHOW_ITEMS_WITH_DATA_AT_TOP,
/**
* The table style element of the slicer style for slicer items with no data
* is applied to slicer items with no data, and slicer items with no data
* are not sorted separately in the list of slicer items in the slicer view.
*/
SHOW_ITEMS_WITH_NO_DATA,
}
/**
* Utility class containing constants.
* Specify the sort type of SlicerCacheItem
* @enum {number}
*/
const SlicerCacheItemSortType = {
/**
* Ascending sort type
*/
ASCENDING,
/**
* Descending sort type
*/
DESCENDING,
}
/**
* Utility class containing constants.
* Specify the style of slicer view
* @enum {number}
*/
const SlicerStyleType = {
/**
* built-in light style one
*/
SLICER_STYLE_LIGHT_1,
/**
* built-in light style two
*/
SLICER_STYLE_LIGHT_2,
/**
* built-in light style three
*/
SLICER_STYLE_LIGHT_3,
/**
* built-in light style four
*/
SLICER_STYLE_LIGHT_4,
/**
* built-in light style five
*/
SLICER_STYLE_LIGHT_5,
/**
* built-in light style six
*/
SLICER_STYLE_LIGHT_6,
/**
* built-in style other one
*/
SLICER_STYLE_OTHER_1,
/**
* built-in style other two
*/
SLICER_STYLE_OTHER_2,
/**
* built-in dark style one
*/
SLICER_STYLE_DARK_1,
/**
* built-in dark style tow
*/
SLICER_STYLE_DARK_2,
/**
* built-in dark style three
*/
SLICER_STYLE_DARK_3,
/**
* built-in dark style four
*/
SLICER_STYLE_DARK_4,
/**
* built-in dark style five
*/
SLICER_STYLE_DARK_5,
/**
* built-in dark style six
*/
SLICER_STYLE_DARK_6,
/**
* user-defined style, unsupported for now
* unsupported
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the type when exporting to slides.
* @enum {number}
*/
const SlideViewType = {
/**
* Exporting as view in MS Excel.
*/
VIEW,
/**
* Exporting as printing.
*/
PRINT,
}
/**
* Utility class containing constants.
* Represents the show type of the smart tag.
* @enum {number}
*/
const SmartTagShowType = {
/**
* Indicates that smart tags are enabled and shown
*/
ALL,
/**
* Indicates that the smart tags are enabled but the indicator not be shown.
*/
NO_SMART_TAG_INDICATOR,
/**
* Indicates that smart tags are disabled and not displayed.
*/
NONE,
}
/**
* Utility class containing constants.
* Sorted value type.
* @enum {number}
*/
const SortOnType = {
/**
* Sorts by cells' value.
*/
VALUE,
/**
* Sorts by cells' color.
*/
CELL_COLOR,
/**
* Sorts by cells' font color.
*/
FONT_COLOR,
/**
* Sorts by conditional icon.
*/
ICON,
}
/**
* Utility class containing constants.
* Represents sort order for the data range.
* @enum {number}
*/
const SortOrder = {
/**
*/
ASCENDING,
/**
*/
DESCENDING,
}
/**
* Utility class containing constants.
* Represents the minimum and maximum value types for the sparkline vertical axis.
* @enum {number}
*/
const SparklineAxisMinMaxType = {
/**
* Automatic for each sparkline.
*/
AUTO_INDIVIDUAL,
/**
* Same for all sparklines in the group.
*/
GROUP,
/**
* Custom value for sparkline.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the preset style types for sparkline.
* @enum {number}
*/
const SparklinePresetStyleType = {
/**
* Style 1
*/
STYLE_1,
/**
* Style 2
*/
STYLE_2,
/**
* Style 3
*/
STYLE_3,
/**
* Style 4
*/
STYLE_4,
/**
* Style 5
*/
STYLE_5,
/**
* Style 6
*/
STYLE_6,
/**
* Style 7
*/
STYLE_7,
/**
* Style 8
*/
STYLE_8,
/**
* Style 9
*/
STYLE_9,
/**
* Style 10
*/
STYLE_10,
/**
* Style 11
*/
STYLE_11,
/**
* Style 12
*/
STYLE_12,
/**
* Style 13
*/
STYLE_13,
/**
* Style 14
*/
STYLE_14,
/**
* Style 15
*/
STYLE_15,
/**
* Style 16
*/
STYLE_16,
/**
* Style 17
*/
STYLE_17,
/**
* Style 18
*/
STYLE_18,
/**
* Style 19
*/
STYLE_19,
/**
* Style 20
*/
STYLE_20,
/**
* Style 21
*/
STYLE_21,
/**
* Style 22
*/
STYLE_22,
/**
* Style 23
*/
STYLE_23,
/**
* Style 24
*/
STYLE_24,
/**
* Style 25
*/
STYLE_25,
/**
* Style 26
*/
STYLE_26,
/**
* Style 27
*/
STYLE_27,
/**
* Style 28
*/
STYLE_28,
/**
* Style 29
*/
STYLE_29,
/**
* Style 30
*/
STYLE_30,
/**
* Style 31
*/
STYLE_31,
/**
* Style 32
*/
STYLE_32,
/**
* Style 33
*/
STYLE_33,
/**
* Style 34
*/
STYLE_34,
/**
* Style 35
*/
STYLE_35,
/**
* Style 36
*/
STYLE_36,
/**
* No preset style.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the sparkline types.
* @enum {number}
*/
const SparklineType = {
/**
* Line sparkline.
*/
LINE,
/**
* Column sparkline.
*/
COLUMN,
/**
* Win/Loss sparkline.
*/
STACKED,
}
/**
* Utility class containing constants.
* Specifies SQL data type of the parameter. Only valid for ODBC sources.
* @enum {number}
*/
const SqlDataType = {
/**
* sql unsigned offset
*/
SQL_UNSIGNED_OFFSET,
/**
* sql signed offset
*/
SQL_SIGNED_OFFSET,
/**
* sql guid
*/
SQL_GUID,
/**
* sql wide long variable char
*/
SQL_W_LONG_VARCHAR,
/**
* sql wide variable char
*/
SQL_W_VARCHAR,
/**
* sql wide char
*/
SQL_W_CHAR,
/**
* sql bit
*/
SQL_BIT,
/**
* sql tiny int
*/
SQL_TINY_INT,
/**
* sql big int
*/
SQL_BIG_INT,
/**
* sql long variable binary
*/
SQL_LONG_VAR_BINARY,
/**
* sql variable binary
*/
SQL_VAR_BINARY,
/**
* sql binary
*/
SQL_BINARY,
/**
* sql long variable char
*/
SQL_LONG_VAR_CHAR,
/**
* sql unknown type
*/
SQL_UNKNOWN_TYPE,
/**
* sql char
*/
SQL_CHAR,
/**
* sql numeric
*/
SQL_NUMERIC,
/**
* sql decimal
*/
SQL_DECIMAL,
/**
* sql integer
*/
SQL_INTEGER,
/**
* sql small int
*/
SQL_SMALL_INT,
/**
* sql float
*/
SQL_FLOAT,
/**
* sql real
*/
SQL_REAL,
/**
* sql double
*/
SQL_DOUBLE,
/**
* sql date type
*/
SQL_TYPE_DATE,
/**
* sql time type
*/
SQL_TYPE_TIME,
/**
* sql timestamp type
*/
SQL_TYPE_TIMESTAMP,
/**
* sql variable char
*/
SQL_VAR_CHAR,
/**
* sql interval year
*/
SQL_INTERVAL_YEAR,
/**
* sql interval month
*/
SQL_INTERVAL_MONTH,
/**
* sql interval day
*/
SQL_INTERVAL_DAY,
/**
* sql interval hour
*/
SQL_INTERVAL_HOUR,
/**
* sql interval minute
*/
SQL_INTERVAL_MINUTE,
/**
* sql interval second
*/
SQL_INTERVAL_SECOND,
/**
* sql interval year to month
*/
SQL_INTERVAL_YEAR_TO_MONTH,
/**
* sql interval day to hour
*/
SQL_INTERVAL_DAY_TO_HOUR,
/**
* sql interval day to minute
*/
SQL_INTERVAL_DAY_TO_MINUTE,
/**
* sql interval day to second
*/
SQL_INTERVAL_DAY_TO_SECOND,
/**
* sql interval hour to minute
*/
SQL_INTERVAL_HOUR_TO_MINUTE,
/**
* sql interval hour to second
*/
SQL_INTERVAL_HOUR_TO_SECOND,
/**
* sql interval minute to second
*/
SQL_INTERVAL_MINUTE_TO_SECOND,
}
/**
* Utility class containing constants.
* Represents the type of operating data.
* @enum {number}
*/
const SqlScriptOperatorType = {
/**
* Insert data.
*/
INSERT,
/**
* Update data.
*/
UPDATE,
/**
* Delete data.
*/
DELETE,
}
/**
* Utility class containing constants.
* The style modified flags.
* @enum {number}
*/
const StyleModifyFlag = {
/**
* Indicates whether left border has been modified for the style.
*/
LEFT_BORDER,
/**
* Indicates whether right border has been modified for the style.
*/
RIGHT_BORDER,
/**
* Indicates whether top border has been modified for the style.
*/
TOP_BORDER,
/**
* Indicates whether bottom border has been modified for the style.
*/
BOTTOM_BORDER,
/**
* Indicates whether diagonal-down border has been modified for the style.
*/
DIAGONAL_DOWN_BORDER,
/**
* Indicates whether diagonal-up border has been modified for the style.
*/
DIAGONAL_UP_BORDER,
/**
* Indicates whether one or more diagonal borders(DIAGONAL_DOWN_BORDER,
* DIAGONAL_UP_BORDER) have been modified for the style.
*/
DIAGONAL,
/**
* Indicates whether horizontal border has been modified for the style.
* Only for dynamic style, such as conditional formatting.
*/
HORIZONTAL_BORDER,
/**
* Indicates whether vertical border has been modified for the style.
* Only for dynamic style, such as conditional formatting.
*/
VERTICAL_BORDER,
/**
* Indicates whether one or more borders(LEFT_BORDER,
* RIGHT_BORDER, TOP_BORDER, BOTTOM_BORDER,
* DIAGONAL, HORIZONTAL_BORDER, VERTICAL_BORDER)
* have been modified for the style.
*/
BORDERS,
/**
* Indicates whether numberformat has been modified.
*/
NUMBER_FORMAT,
/**
* Indicates whether horizontal alignment has been modified.
*/
HORIZONTAL_ALIGNMENT,
/**
* Indicates whether vertical alignment has been modified.
*/
VERTICAL_ALIGNMENT,
/**
* Indicates whether indent property has been modified.
*/
INDENT,
/**
* Indicates whether rotation property has been modified.
*/
ROTATION,
/**
* Indicates whether wrap text property has been modified.
*/
WRAP_TEXT,
/**
* Indicates whether shrink to fit property has been modified.
*/
SHRINK_TO_FIT,
/**
* Indicates whether text direction property has been modified.
*/
TEXT_DIRECTION,
/**
* Indicates whether relative indent property has been modified for the style.
* Only for dynamic style, such as conditional formatting.
*/
RELATIVE_INDENT,
/**
* Indicates whether one or more alignment-related properties(HORIZONTAL_ALIGNMENT,
* VERTICAL_ALIGNMENT, ROTATION, WRAP_TEXT,
* WRAP_TEXT, INDENT, SHRINK_TO_FIT, TEXT_DIRECTION,
* RELATIVE_INDENT) have been modified.
*/
ALIGNMENT_SETTINGS,
/**
* Indicates whether pattern of the shading has been modified.
*/
PATTERN,
/**
* Indicates whether foreground color has been modified.
*/
FOREGROUND_COLOR,
/**
* Indicates whether background color has been modified.
*/
BACKGROUND_COLOR,
/**
* Indicates whether one or more shading-related properties(PATTERN,
* FOREGROUND_COLOR, BACKGROUND_COLOR) have been modified.
*/
CELL_SHADING,
/**
* Indicates whether locked property has been modified.
*/
LOCKED,
/**
* Indicates whether hide formula has been modified.
*/
HIDE_FORMULA,
/**
* Indicates whether one or more protection-related properties(LOCKED,
* HIDE_FORMULA) have been modified.
*/
PROTECTION_SETTINGS,
/**
* Indicates whether font size has been modified.
*/
FONT_SIZE,
/**
* Indicates whether font name has been modified.
*/
FONT_NAME,
/**
* Indicates whether font color has been modified.
*/
FONT_COLOR,
/**
* Indicates whether font weight has been modified.
*/
FONT_WEIGHT,
/**
* Indicates whether italic property of font has been modified.
*/
FONT_ITALIC,
/**
* Indicates whether underline property of font has been modified.
*/
FONT_UNDERLINE,
/**
* Indicates whether strike property font has been modified.
*/
FONT_STRIKE,
/**
* Indicates whether subscript or superscript property of font has been modified.
*/
FONT_SCRIPT,
/**
* Indicates whether font family has been modified.
*/
FONT_FAMILY,
/**
* Indicates whether charset of the font has been modified.
*/
FONT_CHARSET,
/**
* unused.
*/
FONT_SCHEME,
/**
* unused.
*/
FONT_DIRTY,
/**
* unused.
*/
FONT_SPELLING_ERROR,
/**
* unused.
*/
FONT_U_FILL_TX,
/**
* unused.
*/
FONT_SPACING,
/**
* unused.
*/
FONT_KERNING,
/**
* unused.
*/
FONT_EQUALIZE,
/**
* unused.
*/
FONT_CAP,
/**
*/
FONT_VERTICAL_TEXT,
/**
* Indicates whether one or more properties have been modified for the font of the style.
*/
FONT,
/**
* Indicates whether one or more properties have been modified for the style.
*/
ALL,
}
/**
* Utility class containing constants.
* Represents the table's data source type.
* @enum {number}
*/
const TableDataSourceType = {
/**
* Excel Worksheet Table
*/
WORKSHEET,
/**
* Read-write SharePoint linked List
*/
SHARE_POINT,
/**
* XML mapper Table
*/
XML,
/**
* Query Table
*/
QUERY_TABLE,
}
/**
* Utility class containing constants.
* Represents the Table or PivotTable style element type.
* @enum {number}
*/
const TableStyleElementType = {
/**
* Table style element that applies to PivotTable's blank rows.
*/
BLANK_ROW,
/**
* Table style element that applies to table's first column.
*/
FIRST_COLUMN,
/**
* Table style element that applies to table's first column stripes.
*/
FIRST_COLUMN_STRIPE,
/**
* Table style element that applies to PivotTable's first column subheading.
*/
FIRST_COLUMN_SUBHEADING,
/**
* Table style element that applies to table's first header row cell.
*/
FIRST_HEADER_CELL,
/**
* Table style element that applies to table's first row stripes.
*/
FIRST_ROW_STRIPE,
/**
* Table style element that applies to PivotTable's first row subheading.
*/
FIRST_ROW_SUBHEADING,
/**
* Table style element that applies to PivotTable's first subtotal column.
*/
FIRST_SUBTOTAL_COLUMN,
/**
* Table style element that applies to pivot table's first subtotal row.
*/
FIRST_SUBTOTAL_ROW,
/**
* Table style element that applies to pivot table's grand total column.
*/
GRAND_TOTAL_COLUMN,
/**
* Table style element that applies to pivot table's grand total row.
*/
GRAND_TOTAL_ROW,
/**
* Table style element that applies to table's first total row cell.
*/
FIRST_TOTAL_CELL,
/**
* Table style element that applies to table's header row.
*/
HEADER_ROW,
/**
* Table style element that applies to table's last column.
*/
LAST_COLUMN,
/**
* Table style element that applies to table's last header row cell.
*/
LAST_HEADER_CELL,
/**
* Table style element that applies to table's last total row cell.
*/
LAST_TOTAL_CELL,
/**
* Table style element that applies to pivot table's page field labels.
*/
PAGE_FIELD_LABELS,
/**
* Table style element that applies to pivot table's page field values.
*/
PAGE_FIELD_VALUES,
/**
* Table style element that applies to table's second column stripes.
*/
SECOND_COLUMN_STRIPE,
/**
* Table style element that applies to pivot table's second column subheading.
*/
SECOND_COLUMN_SUBHEADING,
/**
* Table style element that applies to table's second row stripes.
*/
SECOND_ROW_STRIPE,
/**
* Table style element that applies to pivot table's second row subheading.
*/
SECOND_ROW_SUBHEADING,
/**
* Table style element that applies to PivotTable's second subtotal column.
*/
SECOND_SUBTOTAL_COLUMN,
/**
* Table style element that applies to PivotTable's second subtotal row.
*/
SECOND_SUBTOTAL_ROW,
/**
* Table style element that applies to PivotTable's third column subheading.
*/
THIRD_COLUMN_SUBHEADING,
/**
* Table style element that applies to PivotTable's third row subheading.
*/
THIRD_ROW_SUBHEADING,
/**
* Table style element that applies to pivot table's third subtotal column.
*/
THIRD_SUBTOTAL_COLUMN,
/**
* Table style element that applies to PivotTable's third subtotal row.
*/
THIRD_SUBTOTAL_ROW,
/**
* Table style element that applies to table's total row.
*/
TOTAL_ROW,
/**
* Table style element that applies to table's entire content.
*/
WHOLE_TABLE,
}
/**
* Utility class containing constants.
* Represents the built-in table style type.
* @enum {number}
*/
const TableStyleType = {
/**
*/
NONE,
/**
*/
TABLE_STYLE_LIGHT_1,
/**
*/
TABLE_STYLE_LIGHT_2,
/**
*/
TABLE_STYLE_LIGHT_3,
/**
*/
TABLE_STYLE_LIGHT_4,
/**
*/
TABLE_STYLE_LIGHT_5,
/**
*/
TABLE_STYLE_LIGHT_6,
/**
*/
TABLE_STYLE_LIGHT_7,
/**
*/
TABLE_STYLE_LIGHT_8,
/**
*/
TABLE_STYLE_LIGHT_9,
/**
*/
TABLE_STYLE_LIGHT_10,
/**
*/
TABLE_STYLE_LIGHT_11,
/**
*/
TABLE_STYLE_LIGHT_12,
/**
*/
TABLE_STYLE_LIGHT_13,
/**
*/
TABLE_STYLE_LIGHT_14,
/**
*/
TABLE_STYLE_LIGHT_15,
/**
*/
TABLE_STYLE_LIGHT_16,
/**
*/
TABLE_STYLE_LIGHT_17,
/**
*/
TABLE_STYLE_LIGHT_18,
/**
*/
TABLE_STYLE_LIGHT_19,
/**
*/
TABLE_STYLE_LIGHT_20,
/**
*/
TABLE_STYLE_LIGHT_21,
/**
*/
TABLE_STYLE_MEDIUM_1,
/**
*/
TABLE_STYLE_MEDIUM_2,
/**
*/
TABLE_STYLE_MEDIUM_3,
/**
*/
TABLE_STYLE_MEDIUM_4,
/**
*/
TABLE_STYLE_MEDIUM_5,
/**
*/
TABLE_STYLE_MEDIUM_6,
/**
*/
TABLE_STYLE_MEDIUM_7,
/**
*/
TABLE_STYLE_MEDIUM_8,
/**
*/
TABLE_STYLE_MEDIUM_9,
/**
*/
TABLE_STYLE_MEDIUM_10,
/**
*/
TABLE_STYLE_MEDIUM_11,
/**
*/
TABLE_STYLE_MEDIUM_12,
/**
*/
TABLE_STYLE_MEDIUM_13,
/**
*/
TABLE_STYLE_MEDIUM_14,
/**
*/
TABLE_STYLE_MEDIUM_15,
/**
*/
TABLE_STYLE_MEDIUM_16,
/**
*/
TABLE_STYLE_MEDIUM_17,
/**
*/
TABLE_STYLE_MEDIUM_18,
/**
*/
TABLE_STYLE_MEDIUM_19,
/**
*/
TABLE_STYLE_MEDIUM_20,
/**
*/
TABLE_STYLE_MEDIUM_21,
/**
*/
TABLE_STYLE_MEDIUM_22,
/**
*/
TABLE_STYLE_MEDIUM_23,
/**
*/
TABLE_STYLE_MEDIUM_24,
/**
*/
TABLE_STYLE_MEDIUM_25,
/**
*/
TABLE_STYLE_MEDIUM_26,
/**
*/
TABLE_STYLE_MEDIUM_27,
/**
*/
TABLE_STYLE_MEDIUM_28,
/**
*/
TABLE_STYLE_DARK_1,
/**
*/
TABLE_STYLE_DARK_2,
/**
*/
TABLE_STYLE_DARK_3,
/**
*/
TABLE_STYLE_DARK_4,
/**
*/
TABLE_STYLE_DARK_5,
/**
*/
TABLE_STYLE_DARK_6,
/**
*/
TABLE_STYLE_DARK_7,
/**
*/
TABLE_STYLE_DARK_8,
/**
*/
TABLE_STYLE_DARK_9,
/**
*/
TABLE_STYLE_DARK_10,
/**
*/
TABLE_STYLE_DARK_11,
/**
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the type of target mode.
* @enum {number}
*/
const TargetModeType = {
/**
* External link
*/
EXTERNAL,
/**
* Local and full paths to files or folders.
*/
FILE_PATH,
/**
* Email.
*/
EMAIL,
/**
* Link on cell or named range.
*/
CELL_REFERENCE,
}
/**
* Utility class containing constants.
* Enumerates text alignment types.
* @enum {number}
*/
const TextAlignmentType = {
/**
* Represents general text alignment.
*/
GENERAL,
/**
* Represents bottom text alignment.
*/
BOTTOM,
/**
* Represents center text alignment.
*/
CENTER,
/**
* Represents center across text alignment.
*/
CENTER_ACROSS,
/**
* Represents distributed text alignment.
*/
DISTRIBUTED,
/**
* Represents fill text alignment.
*/
FILL,
/**
* Represents justify text alignment.
*/
JUSTIFY,
/**
* Represents left text alignment.
*/
LEFT,
/**
* Represents right text alignment.
*/
RIGHT,
/**
* Represents top text alignment.
*/
TOP,
/**
* Aligns the text with an adjusted kashida length for Arabic text.
*/
JUSTIFIED_LOW,
/**
* Distributes Thai text specially, because each character is treated as a word.
*/
THAI_DISTRIBUTED,
}
/**
* Utility class containing constants.
* Represents all automatic number scheme.
* @enum {number}
*/
const TextAutonumberScheme = {
/**
*/
NONE,
/**
* (a), (b), (c), …
*/
ALPHA_LC_PAREN_BOTH,
/**
* a), b), c), …
*/
ALPHA_LC_PAREN_R,
/**
* a., b., c., …
*/
ALPHA_LC_PERIOD,
/**
* (A), (B), (C), …
*/
ALPHA_UC_PAREN_BOTH,
/**
* A), B), C), …
*/
ALPHA_UC_PAREN_R,
/**
* A., B., C., …
*/
ALPHA_UC_PERIOD,
/**
* Bidi Arabic 1 (AraAlpha) with ANSI minus symbol
*/
ARABIC_1_MINUS,
/**
* Bidi Arabic 2 (AraAbjad) with ANSI minus symbol
*/
ARABIC_2_MINUS,
/**
* Dbl-byte Arabic numbers w/ double-byte period
*/
ARABIC_DB_PERIOD,
/**
* Dbl-byte Arabic numbers
*/
ARABIC_DB_PLAIN,
/**
* (1), (2), (3), …
*/
ARABIC_PAREN_BOTH,
/**
* 1), 2), 3), …
*/
ARABIC_PAREN_R,
/**
* 1., 2., 3., …
*/
ARABIC_PERIOD,
/**
* 1, 2, 3, …
*/
ARABIC_PLAIN,
/**
* Dbl-byte circle numbers (1-10 circle[0x2460-], 11-arabic numbers)
*/
CIRCLE_NUM_DB_PLAIN,
/**
* Wingdings black circle numbers
*/
CIRCLE_NUM_WD_BLACK_PLAIN,
/**
* Wingdings white circle numbers (0-10 circle[0x0080-],11- arabic numbers)
*/
CIRCLE_NUM_WD_WHITE_PLAIN,
/**
* EA: Simplified Chinese w/ single-byte period
*/
EA_1_CHS_PERIOD,
/**
* EA: Simplified Chinese (TypeA 1-99, TypeC 100-)
*/
EA_1_CHS_PLAIN,
/**
* EA: Traditional Chinese w/ single-byte period
*/
EA_1_CHT_PERIOD,
/**
* EA: Traditional Chinese (TypeA 1-19, TypeC 20-)
*/
EA_1_CHT_PLAIN,
/**
* EA: Japanese w/ double-byte period
*/
EA_1_JPN_CHS_DB_PERIOD,
/**
* EA: Japanese/Korean w/ single-byte period
*/
EA_1_JPN_KOR_PERIOD,
/**
* EA: Japanese/Korean (TypeC 1-)
*/
EA_1_JPN_KOR_PLAIN,
/**
* Bidi Hebrew 2 with ANSI minus symbol
*/
HEBREW_2_MINUS,
/**
* Hindi alphabet period - consonants
*/
HINDI_ALPHA_1_PERIOD,
/**
* Hindi alphabet period - vowels
*/
HINDI_ALPHA_PERIOD,
/**
* ///
* Hindi numerical parentheses - right
*/
HINDI_NUM_PAREN_R,
/**
* Hindi numerical period
*/
HINDI_NUM_PERIOD,
/**
* (i), (ii), (iii), …
*/
ROMAN_LC_PAREN_BOTH,
/**
* i), ii), iii), …
*/
ROMAN_LC_PAREN_R,
/**
* i., ii., iii., …
*/
ROMAN_LC_PERIOD,
/**
* (I), (II), (III), …
*/
ROMAN_UC_PAREN_BOTH,
/**
* I), II), III), …
*/
ROMAN_UC_PAREN_R,
/**
* I., II., III., …
*/
ROMAN_UC_PERIOD,
/**
* Thai alphabet parentheses - both
*/
THAI_ALPHA_PAREN_BOTH,
/**
* Thai alphabet parentheses - right
*/
THAI_ALPHA_PAREN_R,
/**
* Thai alphabet period
*/
THAI_ALPHA_PERIOD,
/**
* Thai numerical parentheses - both
*/
THAI_NUM_PAREN_BOTH,
/**
* Thai numerical parentheses - right
*/
THAI_NUM_PAREN_R,
/**
* Thai numerical period
*/
THAI_NUM_PERIOD,
}
/**
* Utility class containing constants.
* This type specifies the cap types of the text.
* @enum {number}
*/
const TextCapsType = {
/**
* None caps
*/
NONE,
/**
* Apply all caps on the text.
*/
ALL,
/**
* Apply small caps to the text.
*/
SMALL,
}
/**
* Utility class containing constants.
* Enumerates displaying text type when the text width is larger than cell width.
* @enum {number}
*/
const TextCrossType = {
/**
* Display text like in Microsoft Excel.
*/
DEFAULT,
/**
* Display all the text by crossing other cells and keep text of crossed cells.
*/
CROSS_KEEP,
/**
* Display all the text by crossing other cells and override text of crossed cells.
*/
CROSS_OVERRIDE,
/**
* Only display the text within the width of cell.
*/
STRICT_IN_CELL,
}
/**
* Utility class containing constants.
* Represents the direction of the text flow for this paragraph.
* @enum {number}
*/
const TextDirectionType = {
/**
*/
CONTEXT,
/**
*/
LEFT_TO_RIGHT,
/**
*/
RIGHT_TO_LEFT,
}
/**
* Utility class containing constants.
* Represents the different types of font alignment.
* @enum {number}
*/
const TextFontAlignType = {
/**
* When the text flow is horizontal or simple vertical same as fontBaseline
* but for other vertical modes same as fontCenter.
*/
AUTOMATIC,
/**
* The letters are anchored to the very bottom of a single line.
*/
BOTTOM,
/**
* The letters are anchored to the bottom baseline of a single line.
*/
BASELINE,
/**
* The letters are anchored between the two baselines of a single line.
*/
CENTER,
/**
* The letters are anchored to the top baseline of a single line.
*/
TOP,
}
/**
* Utility class containing constants.
* Represents the node type.
* @enum {number}
*/
const TextNodeType = {
/**
* Represents the text node.
*/
TEXT_RUN,
/**
* Represents the text paragraph.
*/
TEXT_PARAGRAPH,
/**
* Represents the equation text.
*/
EQUATION,
}
/**
* Utility class containing constants.
* Enumerates text orientation types.
* @enum {number}
*/
const TextOrientationType = {
/**
* Rotates text with 90 degrees clockwise.
*/
CLOCK_WISE,
/**
* Rotates text with 90 degrees counterclockwise.
*/
COUNTER_CLOCK_WISE,
/**
* Represents the default value.
*/
NO_ROTATION,
/**
* Displays text from top to bottom of the cell. Stacked text.
*/
TOP_TO_BOTTOM,
}
/**
* Utility class containing constants.
* Represents the way the text vertical or horizontal overflow.
* @enum {number}
*/
const TextOverflowType = {
/**
* Pay attention to top and bottom barriers.
* Provide no indication that there is text which is not visible.
*/
CLIP,
/**
* 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,
/**
* Overflow the text and pay no attention to top and bottom barriers.
*/
OVERFLOW,
}
/**
* Utility class containing constants.
* This type specifies the strike type.
* @enum {number}
*/
const TextStrikeType = {
/**
* A single strikethrough applied on the text.
*/
SINGLE,
/**
* A double strikethrough applied on the text.
*/
DOUBLE,
/**
* No strike is applied to the text.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the text tab alignment types.
* @enum {number}
*/
const TextTabAlignmentType = {
/**
* The text at this tab stop is center aligned.
*/
CENTER,
/**
* At this tab stop, the decimals are lined up.
*/
DECIMAL,
/**
* The text at this tab stop is left aligned.
*/
LEFT,
/**
* The text at this tab stop is right aligned.
*/
RIGHT,
}
/**
* Utility class containing constants.
* Represents the preset texture type.
* @enum {number}
*/
const TextureType = {
/**
* Represents Blue Tissue Paper texture type.
*/
BLUE_TISSUE_PAPER,
/**
* Represents Bouquet texture type.
*/
BOUQUET,
/**
* Represents Brown Marble texture type.
*/
BROWN_MARBLE,
/**
* Represents Canvas texture type.
*/
CANVAS,
/**
* Represents Cork texture type.
*/
CORK,
/**
* Represents Denim texture type.
*/
DENIM,
/**
* Represents Fish Fossil texture type.
*/
FISH_FOSSIL,
/**
* Represents Granite texture type.
*/
GRANITE,
/**
* Represents Green Marble texture type.
*/
GREEN_MARBLE,
/**
* Represents Medium Wood texture type.
*/
MEDIUM_WOOD,
/**
* Represents Newsprint texture type.
*/
NEWSPRINT,
/**
* Represents Oak texture type.
*/
OAK,
/**
* Represents Paper Bag texture type.
*/
PAPER_BAG,
/**
* Represents Papyrus texture type.
*/
PAPYRUS,
/**
* Represents Parchment texture type.
*/
PARCHMENT,
/**
* Represents Pink Tissue Paper texture type.
*/
PINK_TISSUE_PAPER,
/**
* Represents Purple Mesh texture type.
*/
PURPLE_MESH,
/**
* Represents Recycled Paper texture type.
*/
RECYCLED_PAPER,
/**
* Represents Sand texture type.
*/
SAND,
/**
* Represents Stationery texture type.
*/
STATIONERY,
/**
* Represents Walnut Droplets texture type.
*/
WALNUT,
/**
* Represents Water Droplets texture type.
*/
WATER_DROPLETS,
/**
* Represents White Marble texture type.
*/
WHITE_MARBLE,
/**
* Represents Woven Mat texture type.
*/
WOVEN_MAT,
/**
* Represents Unknown texture type.
*/
UNKNOWN,
}
/**
* Utility class containing constants.
* Represents the text direct type.
* @enum {number}
*/
const TextVerticalType = {
/**
* East Asian Vertical display.
*/
VERTICAL,
/**
* Horizontal text.
*/
HORIZONTAL,
/**
* Displayed vertical and the text flows top down then LEFT to RIGHT
*/
VERTICAL_LEFT_TO_RIGHT,
/**
* Each line is 90 degrees rotated clockwise
*/
VERTICAL_90,
/**
* Each line is 270 degrees rotated clockwise
*/
VERTICAL_270,
/**
* Determines if all of the text is vertical
*/
STACKED,
/**
* Specifies that vertical WordArt should be shown from right to left rather than left to right.
*/
STACKED_RIGHT_TO_LEFT,
}
/**
* Utility class containing constants.
* Enumerates the theme color types.
* @enum {number}
*/
const ThemeColorType = {
/**
*/
BACKGROUND_1,
/**
*/
TEXT_1,
/**
*/
BACKGROUND_2,
/**
*/
TEXT_2,
/**
*/
ACCENT_1,
/**
*/
ACCENT_2,
/**
*/
ACCENT_3,
/**
*/
ACCENT_4,
/**
*/
ACCENT_5,
/**
*/
ACCENT_6,
/**
*/
HYPERLINK,
/**
*/
FOLLOWED_HYPERLINK,
/**
* Inner used.
* A color used in theme definitions which means to use the color of the style.
*/
STYLE_COLOR,
}
/**
* Utility class containing constants.
* Represents the text alignment type for the tick labels on the axis
* @enum {number}
*/
const TickLabelAlignmentType = {
/**
* Represents the text shall be centered.
*/
CENTER,
/**
* Represents the text shall be left justified.
*/
LEFT,
/**
* Represents the text shall be right justified.
*/
RIGHT,
}
/**
* Utility class containing constants.
* Represents the position type of tick-mark labels on the specified axis.
* @enum {number}
*/
const TickLabelPositionType = {
/**
* Position type is high.
*/
HIGH,
/**
* Position type is low.
*/
LOW,
/**
* Position type is next to axis.
*/
NEXT_TO_AXIS,
/**
* Position type is none.
*/
NONE,
}
/**
* Utility class containing constants.
* Represents the tick mark type for the specified axis.
* @enum {number}
*/
const TickMarkType = {
/**
* Tick mark type is Cross.
*/
CROSS,
/**
* Tick mark type is Inside.
*/
INSIDE,
/**
* Tick mark type is None.
*/
NONE,
/**
* Tick mark type is Outside
*/
OUTSIDE,
}
/**
* Utility class containing constants.
* Specifies what type of compression to apply when saving images into TIFF format file.
* @enum {number}
*/
const TiffCompression = {
/**
* Specifies no compression.
*/
COMPRESSION_NONE,
/**
* Specifies the RLE compression scheme.
*/
COMPRESSION_RLE,
/**
* Specifies the LZW compression scheme.
*/
COMPRESSION_LZW,
/**
* Specifies the CCITT3 compression scheme.
*/
COMPRESSION_CCITT_3,
/**
* Specifies the CCITT4 compression scheme.
*/
COMPRESSION_CCITT_4,
}
/**
* Utility class containing constants.
* 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.
* @enum {number}
*/
const TimePeriodType = {
/**
* Today's date.
*/
TODAY,
/**
* Yesterday's date.
*/
YESTERDAY,
/**
* Tomorrow's date.
*/
TOMORROW,
/**
* A date in the last seven days.
*/
LAST_7_DAYS,
/**
* A date occurring in this calendar month.
*/
THIS_MONTH,
/**
* A date occurring in the last calendar month.
*/
LAST_MONTH,
/**
* A date occurring in the next calendar month.
*/
NEXT_MONTH,
/**
* A date occurring this week.
*/
THIS_WEEK,
/**
* A date occurring last week.
*/
LAST_WEEK,
/**
* A date occurring next week.
*/
NEXT_WEEK,
/**
* A date occurring this year.
* Only for .ods.
*/
THIS_YEAR,
/**
* A date occurring last year.
* Only for .ods.
*/
LAST_YEAR,
/**
* A date occurring next year.
* Only for .ods.
*/
NEXT_YEAR,
}
/**
* Utility class containing constants.
* Represents the base unit for the category axis.
* @enum {number}
*/
const TimeUnit = {
/**
* Days
*/
DAYS,
/**
* Months
*/
MONTHS,
/**
* Years
*/
YEARS,
}
/**
* Utility class containing constants.
* Determines the type of calculation in the Totals row of the list column.
* @enum {number}
*/
const TotalsCalculation = {
/**
* Represents Sum totals calculation.
*/
SUM,
/**
* Represents Count totals calculation.
*/
COUNT,
/**
* Represents Average totals calculation.
*/
AVERAGE,
/**
* Represents Max totals calculation.
*/
MAX,
/**
* Represents Min totals calculation.
*/
MIN,
/**
* Represents Var totals calculation.
*/
VAR,
/**
* Represents Count Nums totals calculation.
*/
COUNT_NUMS,
/**
* Represents StdDev totals calculation.
*/
STD_DEV,
/**
* Represents No totals calculation.
*/
NONE,
/**
* Represents custom calculation.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the trendline type.
* @enum {number}
*/
const TrendlineType = {
/**
* Exponential
*/
EXPONENTIAL,
/**
* Linear
*/
LINEAR,
/**
* Logarithmic
*/
LOGARITHMIC,
/**
* MovingAverage
*/
MOVING_AVERAGE,
/**
* Polynomial
*/
POLYNOMIAL,
/**
* Power
*/
POWER,
}
/**
* Utility class containing constants.
* Specifies how to apply style for parsed values when converting string value to number or datetime.
* @enum {number}
*/
const TxtLoadStyleStrategy = {
/**
* Does not set style for the parsed value.
*/
NONE,
/**
* Set the style as built-in number/datetime when the parsed value are plain numeric/datetime values.
* 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.
*/
BUILT_IN,
/**
* Set the exact custom format for the parsed value to make the formatted value be same with the original input one.
*/
EXACT_FORMAT,
}
/**
* Utility class containing constants.
* Specifies the type of using quotation marks for values in text format files.
* @enum {number}
*/
const 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,
/**
* All values will be quoted always.
*/
ALWAYS,
/**
* 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,
/**
* 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,
}
/**
* Utility class containing constants.
* Represents how to update links to other workbooks when the workbook is opened.
* @enum {number}
*/
const UpdateLinksType = {
/**
* Prompt user to update.
*/
USER_SET,
/**
* Do not update, and do not prompt user.
*/
NEVER,
/**
* Always update.
*/
ALWAYS,
}
/**
* Utility class containing constants.
* Represents the data validation alert style.
* @enum {number}
*/
const ValidationAlertType = {
/**
* Information alert style.
*/
INFORMATION,
/**
* Stop alert style.
*/
STOP,
/**
* Warning alert style.
*/
WARNING,
}
/**
* Utility class containing constants.
* Represents data validation type.
* @enum {number}
*/
const ValidationType = {
/**
* Any value validation type.
*/
ANY_VALUE,
/**
* Whole number validation type.
*/
WHOLE_NUMBER,
/**
* Decimal validation type.
*/
DECIMAL,
/**
* List validation type.
*/
LIST,
/**
* Date validation type.
*/
DATE,
/**
* Time validation type.
*/
TIME,
/**
* Text length validation type.
*/
TEXT_LENGTH,
/**
* Custom validation type.
*/
CUSTOM,
}
/**
* Utility class containing constants.
* Represents the type of VBA module.
* @enum {number}
*/
const VbaModuleType = {
/**
* Represents a procedural module.
*/
PROCEDURAL,
/**
* Represents a document module.
*/
DOCUMENT,
/**
* Represents a class module.
*/
CLASS,
/**
* Represents a designer module.
*/
DESIGNER,
}
/**
* Utility class containing constants.
* Represents the type of VBA project reference.
* @enum {number}
*/
const VbaProjectReferenceType = {
/**
* Specifies a reference to an Automation type library.
*/
REGISTERED,
/**
* Specifies a reference to a twiddled type library and its extended type library.
*/
CONTROL,
/**
* Specifies a reference to an external VBA project.
*/
PROJECT,
}
/**
* Utility class containing constants.
* Represents the view type of the worksheet.
* @enum {number}
*/
const ViewType = {
/**
*/
NORMAL_VIEW,
/**
*/
PAGE_BREAK_PREVIEW,
/**
*/
PAGE_LAYOUT_VIEW,
}
/**
* Utility class containing constants.
* Represents the states for sheet visibility.
* @enum {number}
*/
const VisibilityType = {
/**
* Indicates the sheet is visible.
*/
VISIBLE,
/**
* Indicates the sheet is hidden, but can be shown by the user via the user interface.
*/
HIDDEN,
/**
* Indicates the sheet is hidden and cannot be shown in the user interface (UI).
* This state is only available programmatically.
*/
VERY_HIDDEN,
}
/**
* Utility class containing constants.
* Represents the store type of web extension.
* @enum {number}
*/
const WebExtensionStoreType = {
/**
* Specifies that the store type is Office.com.
*/
OMEX,
/**
* Specifies that the store type is SharePoint corporate catalog.
*/
SP_CATALOG,
/**
* Specifies that the store type is a SharePoint web application.
*/
SP_APP,
/**
* Specifies that the store type is an Exchange server.
*/
EXCHANGE,
/**
* Specifies that the store type is a file system share.
*/
FILE_SYSTEM,
/**
* Specifies that the store type is the system registry.
*/
REGISTRY,
/**
* Specifies that the store type is Centralized Deployment via Exchange.
*/
EX_CATALOG,
}
/**
* Utility class containing constants.
* Enumerates the weight types for a picture border or a chart line.
* @enum {number}
*/
const WeightType = {
/**
* Represents the weight of hair line.
*/
HAIR_LINE,
/**
* Represents the weight of medium line.
*/
MEDIUM_LINE,
/**
* Represents the weight of single line.
*/
SINGLE_LINE,
/**
* Represents the weight of wide line.
*/
WIDE_LINE,
}
/**
* Utility class containing constants.
* Type of XML Advanced Electronic Signature (XAdES).
* @enum {number}
*/
const XAdESType = {
/**
* XAdES is off.
*/
NONE,
/**
* Basic XAdES.
*/
X_AD_ES,
}