/**
* 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 CalculationCell items representing cells that
* depend on circular references.
* @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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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 object that contains fill formatting properties for the specified chart or shape.
* See Also:FillFormat
*/
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) {
}
/**
*/
isAuto() {
}
/**
*/
isVisible() {
}
/**
*/
setAuto(isAuto) {
}
}
/**
* 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.
*/
getAxisLabels() {
}
/**
* Represents bins on a chart(Histogram/Pareto) axis
*/
getBins() {
}
/**
* Indicates whether Microsoft Workbook automatically sets the axis crossing point.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Charts.Axis.CrossType property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isAutoCross() {
}
/**
* Indicates whether Microsoft Workbook automatically sets the axis crossing point.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Charts.Axis.CrossType property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
isCrossAtMax() {
}
/**
* Sets the axis crossing point as automatic.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Charts.Axis.CrossType property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setAutoCross() {
}
/**
* Sets whether the axis crosses at the maximum value.
* NOTE: This member is now obsolete. Instead,
* please use Aspose.Cells.Charts.Axis.CrossType property.
* This property will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setCrossAtMax(isCrossAtMax) {
}
}
/**
* Represents axis bins
*/
class AxisBins {
/**
*/
constructor() {
}
/**
* 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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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) {
}
/**
* Specifies the stack size for calculating cells recursively.
* 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.
* Too small value may cause performance degradation for the formula calculation.
*/
getCalcStackSize() {
}
/**
* Specifies the stack size for calculating cells recursively.
* 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.
* Too small value may cause performance degradation for the formula calculation.
*/
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 inner 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.
*/
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 and 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) {
}
/**
* 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 cell string value is a rich 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 cell style.
* @param {Style} style - The cell style.
* @param {boolean} explicitFlag - True, only overwriting formatting which is explicitly set.
*/
setStyle(style, explicitFlag) {
}
/**
* Apply the cell style.
* @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.
*/
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.
*/
getStyle() {
}
/**
* Gets and sets the default style.
*/
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 Cell item within the worksheet
* The element at the specified index.NOTE: This member is now obsolete.
* Instead, please use Cells.GetEnumerator() method to iterate all cells in this worksheet.
* This property will be removed 12 months later since February 2015.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} index - The zero based index of the element.
*/
get(index) {
}
/**
* 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) {
}
/**
* 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 with the input string.
* Returns null (Nothing) if no cell is found.
* NOTE: This member is now obsolete. Instead,
* please use Cells.Find(object,Cell,FindOptions) method with LookInType as LookInType.OnlyFormulas
* and LookAtType as LookAtType.EntireContent.
* This member will be removed 12 months later since November 2018.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} formula - The formula to search for.
* @param {Cell} previousCell - Previous cell with the same formula. This parameter can be set to null if searching from the start.
* @return {Cell} Cell object.
*/
findFormula(formula, previousCell) {
}
/**
* Finds the cell with formula which contains the input string.
* Returns null (Nothing) if no cell is found.
* NOTE: This member is now obsolete. Instead,
* please use Cells.Find(object,Cell,FindOptions) method with LookInType as LookInType.OnlyFormulas
* and LookAtType as LookAtType.Contains.
* This member will be removed 12 months later since November 2018.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {String} formula - The formula to search for.
* @param {Cell} previousCell - Previous cell with the same formula. This parameter can be set to null if searching from the start.
* @return {Cell} Cell object.
*/
findFormulaContains(formula, 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.
* @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) {
}
/**
* 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 string data in cells 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) {
}
/**
* 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) {
}
/**
* 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 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) {
}
/**
* 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) {
}
/**
* 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 the Cell element at the specified cell row index and column index.
* NOTE: This member is now obsolete. Instead,
* please use Cells.Get(int,int) method.
* This method will be removed 12 months later since JANUARY 2012.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} row - Row index
* @param {Number} column - Column index
* @return {Cell} Return Cell object.
*/
getCell(row, column) {
}
/**
* Gets the Row element or at the specified cell row index.
* NOTE: This member is now obsolete. Instead,
* please use RowCollection[int] method.
* This method will be removed 12 months later since JANUARY 2010.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} row - Row index
* @return {Row}
* return the row object.
*/
getRow(row) {
}
/**
* Gets the Column element or at the specified cell row index.
* NOTE: This member is now obsolete. Instead,
* please use ColumnCollection[int] method.
* This method will be removed 12 months later since JANUARY 2010.
* Aspose apologizes for any inconvenience you may have experienced.
* @param {Number} columnIndex - The column index.
* @return {Column}
*/
getColumn(columnIndex) {
}
/**
* 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 at the specified cell row index.
* @param {Number} row - Row index
* @return {Row}
* If the row object does exist return Row object, otherwise return 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 cell and row objects.
*/
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) {
}
/**
* 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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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() {
}
/**
* 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() {
}
}
/**
* 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 object that holds the visual shape properties of the ChartPoint.
* See Also:ShapePropertyCollection
*/
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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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 the color filter.
* @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 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");See Also:Column
* @hideconstructor
*/
class ColumnCollection {
/**
*/
getCount() {
}
/**
* Gets a object by column index.
* The Column object of given column index will be instantiated if it does not exist before.
* See Also:Column
*/
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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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.
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
}
/**
* 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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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 {
/**
*/
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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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 DataLablesSeparatorType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use DataLabels.SeparatorType property.
* This property will be removed 12 months later since September 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getSeparator() {
}
/**
* Gets or sets the separator type used for the data labels on a chart.
* The value of the property is DataLablesSeparatorType integer constant.
* NOTE: This member is now obsolete. Instead,
* please use DataLabels.SeparatorType property.
* This property will be removed 12 months later since September 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setSeparator(value) {
}
/**
* 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 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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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) {
}
/**
* 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) {
}
/**
* 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() {
}
/**
* 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
* See Also:clear(boolean)
*/
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) {
}
/**
* Indicates whether the AutoFilter button for this column is visible.
* NOTE: This member is now obsolete.
* Instead, please use FilterColumn.IsDropdownVisible to check whether the AutoFilter button for this column is visible.
* This property will be removed 12 months later since September 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
getVisibledropdown() {
}
/**
* Indicates whether the AutoFilter button for this column is visible.
* NOTE: This member is now obsolete.
* Instead, please use FilterColumn.IsDropdownVisible to check whether the AutoFilter button for this column is visible.
* This property will be removed 12 months later since September 2020.
* Aspose apologizes for any inconvenience you may have experienced.
*/
setVisibledropdown(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 object that contains fill formatting properties for the specified chart or shape.
* See Also:FillFormat
*/
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) {
}
/**
*/
isAuto() {
}
/**
*/
isVisible() {
}
/**
*/
setAuto(isAuto) {
}
}
/**
* 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 object that holds the properties associated with defining a bevel on the top or front face of a shape.
* See Also:Bevel
*/
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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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 .
* @return {ArrayList} All Characters objects
*/
getCharacters() {
}
/**
* 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 object that specifies shadow effect for the chart element or shape.
* See Also:ShadowEffect
*/
getShadowEffect() {
}
/**
* Represents a object that specifies reflection effect for the chart element or shape.
* See Also:ReflectionEffect
*/
getReflection() {
}
/**
* Represents a object that specifies glow effect for the chart element or shape.
* See Also:GlowEffect
*/
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.