diff --git a/apps/common/main/resources/img/toolbar/equationicons.svg b/apps/common/main/resources/img/toolbar/equationicons.svg index eb48fc0c8f..90479d415c 100644 --- a/apps/common/main/resources/img/toolbar/equationicons.svg +++ b/apps/common/main/resources/img/toolbar/equationicons.svg @@ -1,47 +1,41 @@ -"none" - no border will be added to the created element or the selected element side. - * * "single" - a single border will be added to the created element or the selected element side. + * "none" - no border will be added to the created element or the selected element side. + * "single" - a single border will be added to the created element or the selected element side. * @typedef {("none" | "single")} BorderType */ @@ -272,36 +368,36 @@ function ApiWatermarkSettings(oSettings){} /** * Header and footer types which can be applied to the document sections. - * * "default" - a header or footer which can be applied to any default page. - * * "title" - a header or footer which is applied to the title page. - * * "even" - a header or footer which can be applied to even pages to distinguish them from the odd ones (which will be considered default). + * "default" - a header or footer which can be applied to any default page. + * "title" - a header or footer which is applied to the title page. + * "even" - a header or footer which can be applied to even pages to distinguish them from the odd ones (which will be considered default). * @typedef {("default" | "title" | "even")} HdrFtrType */ /** * The possible values for the units of the width property are defined by a specific table or table cell width property. - * * "auto" - sets the table or table cell width to auto width. - * * "twips" - sets the table or table cell width to be measured in twentieths of a point. - * * "nul" - sets the table or table cell width to be of a zero value. - * * "percent" - sets the table or table cell width to be measured in percent to the parent container. + * "auto" - sets the table or table cell width to auto width. + * "twips" - sets the table or table cell width to be measured in twentieths of a point. + * "nul" - sets the table or table cell width to be of a zero value. + * "percent" - sets the table or table cell width to be measured in percent to the parent container. * @typedef {("auto" | "twips" | "nul" | "percent")} TableWidth */ /** * This simple type specifies possible values for the table sections to which the current conditional formatting properties will be applied when this selected table style is used. - * * "topLeftCell" - specifies that the table formatting is applied to the top left cell. - * * "topRightCell" - specifies that the table formatting is applied to the top right cell. - * * "bottomLeftCell" - specifies that the table formatting is applied to the bottom left cell. - * * "bottomRightCell" - specifies that the table formatting is applied to the bottom right cell. - * * "firstRow" - specifies that the table formatting is applied to the first row. - * * "lastRow" - specifies that the table formatting is applied to the last row. - * * "firstColumn" - specifies that the table formatting is applied to the first column. Any subsequent row which is in *table header* ({@link ApiTableRowPr#SetTableHeader}) will also use this conditional format. - * * "lastColumn" - specifies that the table formatting is applied to the last column. - * * "bandedColumn" - specifies that the table formatting is applied to odd numbered groupings of rows. - * * "bandedColumnEven" - specifies that the table formatting is applied to even numbered groupings of rows. - * * "bandedRow" - specifies that the table formatting is applied to odd numbered groupings of columns. - * * "bandedRowEven" - specifies that the table formatting is applied to even numbered groupings of columns. - * * "wholeTable" - specifies that the conditional formatting is applied to the whole table. + * "topLeftCell" - specifies that the table formatting is applied to the top left cell. + * "topRightCell" - specifies that the table formatting is applied to the top right cell. + * "bottomLeftCell" - specifies that the table formatting is applied to the bottom left cell. + * "bottomRightCell" - specifies that the table formatting is applied to the bottom right cell. + * "firstRow" - specifies that the table formatting is applied to the first row. + * "lastRow" - specifies that the table formatting is applied to the last row. + * "firstColumn" - specifies that the table formatting is applied to the first column. Any subsequent row which is in *table header* ({@link ApiTableRowPr#SetTableHeader}) will also use this conditional format. + * "lastColumn" - specifies that the table formatting is applied to the last column. + * "bandedColumn" - specifies that the table formatting is applied to odd numbered groupings of rows. + * "bandedColumnEven" - specifies that the table formatting is applied to even numbered groupings of rows. + * "bandedRow" - specifies that the table formatting is applied to odd numbered groupings of columns. + * "bandedRowEven" - specifies that the table formatting is applied to even numbered groupings of columns. + * "wholeTable" - specifies that the conditional formatting is applied to the whole table. * @typedef {("topLeftCell" | "topRightCell" | "bottomLeftCell" | "bottomRightCell" | "firstRow" | "lastRow" | * "firstColumn" | "lastColumn" | "bandedColumn" | "bandedColumnEven" | "bandedRow" | "bandedRowEven" | * "wholeTable")} TableStyleOverrideType @@ -348,19 +444,25 @@ function ApiWatermarkSettings(oSettings){} * "barStackedPercent3DPerspective" | "horizontalBar" | "horizontalBarStacked" | "horizontalBarStackedPercent" * | "horizontalBar3D" | "horizontalBarStacked3D" | "horizontalBarStackedPercent3D" | "lineNormal" | * "lineStacked" | "lineStackedPercent" | "line3D" | "pie" | "pie3D" | "doughnut" | "scatter" | "stock" | - * "area" | "areaStacked" | "areaStackedPercent")} ChartType + * "area" | "areaStacked" | "areaStackedPercent" | "comboBarLine" | "comboBarLineSecondary" | "comboCustom" | "unknown")} ChartType + */ + +/** + * This type specifies the type of drawing lock. + * @typedef {("noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" + * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox")} DrawingLockType */ /** * The available text vertical alignment (used to align text in a shape with a placement for text inside it). * @typedef {("top" | "center" | "bottom")} VerticalTextAlign - * */ + */ /** * The available color scheme identifiers. * @typedef {("accent1" | "accent2" | "accent3" | "accent4" | "accent5" | "accent6" | "bg1" | "bg2" | "dk1" | "dk2" * | "lt1" | "lt2" | "tx1" | "tx2")} SchemeColorId - * */ + */ /** * The available preset color names. @@ -375,23 +477,23 @@ function ApiWatermarkSettings(oSettings){} * "dkSlateGray" | "dkSlateGrey" | "dkTurquoise" | "dkViolet" | "dodgerBlue" | "firebrick" | "floralWhite" | * "forestGreen" | "fuchsia" | "gainsboro" | "ghostWhite" | "gold" | "goldenrod" | "gray" | "green" | * "greenYellow" | "grey" | "honeydew" | "hotPink" | "indianRed" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderBlush" | "lawnGreen" | "lemonChiffon" | "lightBlue" | "lightCoral" | "lightCyan" | "lightGoldenrodYellow" | "lightGray" | "lightGreen" | "lightGrey" | "lightPink" | "lightSalmon" | "lightSeaGreen" | "lightSkyBlue" | "lightSlateGray" | "lightSlateGrey" | "lightSteelBlue" | "lightYellow" | "lime" | "limeGreen" | "linen" | "ltBlue" | "ltCoral" | "ltCyan" | "ltGoldenrodYellow" | "ltGray" | "ltGreen" | "ltGrey" | "ltPink" | "ltSalmon" | "ltSeaGreen" | "ltSkyBlue" | "ltSlateGray" | "ltSlateGrey" | "ltSteelBlue" | "ltYellow" | "magenta" | "maroon" | "medAquamarine" | "medBlue" | "mediumAquamarine" | "mediumBlue" | "mediumOrchid" | "mediumPurple" | "mediumSeaGreen" | "mediumSlateBlue" | "mediumSpringGreen" | "mediumTurquoise" | "mediumVioletRed" | "medOrchid" | "medPurple" | "medSeaGreen" | "medSlateBlue" | "medSpringGreen" | "medTurquoise" | "medVioletRed" | "midnightBlue" | "mintCream" | "mistyRose" | "moccasin" | "navajoWhite" | "navy" | "oldLace" | "olive" | "oliveDrab" | "orange" | "orangeRed" | "orchid" | "paleGoldenrod" | "paleGreen" | "paleTurquoise" | "paleVioletRed" | "papayaWhip" | "peachPuff" | "peru" | "pink" | "plum" | "powderBlue" | "purple" | "red" | "rosyBrown" | "royalBlue" | "saddleBrown" | "salmon" | "sandyBrown" | "seaGreen" | "seaShell" | "sienna" | "silver" | "skyBlue" | "slateBlue" | "slateGray" | "slateGrey" | "snow" | "springGreen" | "steelBlue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whiteSmoke" | "yellow" | "yellowGreen")} PresetColor - * */ + */ /** * Possible values for the position of chart tick labels (either horizontal or vertical). - * * "none" - not display the selected tick labels. - * * "nextTo" - sets the position of the selected tick labels next to the main label. - * * "low" - sets the position of the selected tick labels in the part of the chart with lower values. - * * "high" - sets the position of the selected tick labels in the part of the chart with higher values. + * "none" - not display the selected tick labels. + * "nextTo" - sets the position of the selected tick labels next to the main label. + * "low" - sets the position of the selected tick labels in the part of the chart with lower values. + * "high" - sets the position of the selected tick labels in the part of the chart with higher values. * @typedef {("none" | "nextTo" | "low" | "high")} TickLabelPosition - * **/ + */ /** * The type of a fill which uses an image as a background. - * * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. - * * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. + * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. + * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. * @typedef {"tile" | "stretch"} BlipFillType - * */ + */ /** * The available preset patterns which can be used for the fill. @@ -402,7 +504,7 @@ function ApiWatermarkSettings(oSettings){} * "pct75" | "pct80" | "pct90" | "plaid" | "shingle" | "smCheck" | "smConfetti" | "smGrid" | "solidDmnd" | * "sphere" | "trellis" | "upDiag" | "vert" | "wave" | "wdDnDiag" | "wdUpDiag" | "weave" | "zigZag"} * PatternType - * */ + */ /** * @@ -418,12 +520,12 @@ function ApiWatermarkSettings(oSettings){} * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform - * */ + */ /** * Form type. * The available form types. - * @typedef {"textForm" | "comboBoxForm" | "dropDownForm" | "checkBoxForm" | "radioButtonForm" | "pictureForm"} FormType + * @typedef {"textForm" | "comboBoxForm" | "dropDownForm" | "checkBoxForm" | "radioButtonForm" | "pictureForm" | "complexForm"} FormType */ /** @@ -449,62 +551,62 @@ function ApiWatermarkSettings(oSettings){} /** * Available values of the "numbered" reference type: - * * "pageNum" - the numbered item page number; - * * "paraNum" - the numbered item paragraph number; - * * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); - * * "fullCtxParaNum" - the full paragraph number, e.g. "4.1.1"; - * * "text" - the paragraph text value, e.g. if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "pageNum" - the numbered item page number; + * "paraNum" - the numbered item paragraph number; + * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); + * "fullCtxParaNum" - the full paragraph number, e.g. "4.1.1"; + * "text" - the paragraph text value, e.g. if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "text" | "aboveBelow"} numberedRefTo */ /** * Available values of the "heading" reference type: - * * "text" - the entire heading text; - * * "pageNum" - the heading page number; - * * "headingNum" - the heading sequence number; - * * "noCtxHeadingNum" - the abbreviated heading number. Make sure the cursor pointer is in the section you are referencing to, e.g. you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; - * * "fullCtxHeadingNum" - the full heading number even if the cursor pointer is in the same section; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "text" - the entire heading text; + * "pageNum" - the heading page number; + * "headingNum" - the heading sequence number; + * "noCtxHeadingNum" - the abbreviated heading number. Make sure the cursor pointer is in the section you are referencing to, e.g. you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; + * "fullCtxHeadingNum" - the full heading number even if the cursor pointer is in the same section; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"text" | "pageNum" | "headingNum" | "noCtxHeadingNum" | "fullCtxHeadingNum" | "aboveBelow"} headingRefTo */ /** * Available values of the "bookmark" reference type: - * * "text" - the entire bookmark text; - * * "pageNum" - the bookmark page number; - * * "paraNum" - the bookmark paragraph number; - * * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); - * * "fullCtxParaNum - the full paragraph number, e.g. "4.1.1"; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "text" - the entire bookmark text; + * "pageNum" - the bookmark page number; + * "paraNum" - the bookmark paragraph number; + * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); + * "fullCtxParaNum - the full paragraph number, e.g. "4.1.1"; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"text" | "pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "aboveBelow"} bookmarkRefTo */ /** * Available values of the "footnote" reference type: - * * "footnoteNum" - the footnote number; - * * "pageNum" - the page number of the footnote; - * * "aboveBelow" - the words "above" or "below" depending on the position of the item; - * * "formFootnoteNum" - the form number formatted as a footnote. The numbering of the actual footnotes is not affected. + * "footnoteNum" - the footnote number; + * "pageNum" - the page number of the footnote; + * "aboveBelow" - the words "above" or "below" depending on the position of the item; + * "formFootnoteNum" - the form number formatted as a footnote. The numbering of the actual footnotes is not affected. * @typedef {"footnoteNum" | "pageNum" | "aboveBelow" | "formFootnoteNum"} footnoteRefTo */ /** * Available values of the "endnote" reference type: - * * "endnoteNum" - the endnote number; - * * "pageNum" - the endnote page number; - * * "aboveBelow" - the words "above" or "below" depending on the item position; - * * "formEndnoteNum" - the form number formatted as an endnote. The numbering of the actual endnotes is not affected. + * "endnoteNum" - the endnote number; + * "pageNum" - the endnote page number; + * "aboveBelow" - the words "above" or "below" depending on the item position; + * "formEndnoteNum" - the form number formatted as an endnote. The numbering of the actual endnotes is not affected. * @typedef {"endnoteNum" | "pageNum" | "aboveBelow" | "formEndnoteNum"} endnoteRefTo */ /** * Available values of the "equation"/"figure"/"table" reference type: - * * "entireCaption"- the entire caption text; - * * "labelNumber" - the label and object number only, e.g. "Table 1.1"; - * * "captionText" - the caption text only; - * * "pageNum" - the page number containing the referenced object; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "entireCaption"- the entire caption text; + * "labelNumber" - the label and object number only, e.g. "Table 1.1"; + * "captionText" - the caption text only; + * "pageNum" - the page number containing the referenced object; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"entireCaption" | "labelNumber" | "captionText" | "pageNum" | "aboveBelow"} captionRefTo */ @@ -517,8 +619,8 @@ function ApiWatermarkSettings(oSettings){} * Standard numeric format. * @typedef {("General" | "0" | "0.00" | "#,##0" | "#,##0.00" | "0%" | "0.00%" | * "0.00E+00" | "# ?/?" | "# ??/??" | "m/d/yyyy" | "d-mmm-yy" | "d-mmm" | "mmm-yy" | "h:mm AM/PM" | - * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_);(#,##0)" | "#,##0_);[Red](#,##0)" | - * "#,##0.00_);(#,##0.00)" | "#,##0.00_);[Red](#,##0.00)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_\);(#,##0)" | "#,##0_\);\[Red\]\(#,##0)" | + * "#,##0.00_\);\(#,##0.00\)" | "#,##0.00_\);\[Red\]\(#,##0.00\)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat */ /** @@ -528,28 +630,28 @@ function ApiWatermarkSettings(oSettings){} /** * Possible values for the caption numbering format. - * * "ALPHABETIC" - upper letter. - * * "alphabetic" - lower letter. - * * "Roman" - upper Roman. - * * "roman" - lower Roman. - * * "Arabic" - arabic. + * "ALPHABETIC" - upper letter. + * "alphabetic" - lower letter. + * "Roman" - upper Roman. + * "roman" - lower Roman. + * "Arabic" - arabic. * @typedef {("ALPHABETIC" | "alphabetic" | "Roman" | "roman" | "Arabic")} CaptionNumberingFormat - * **/ + */ /** * Possible values for the caption separator. - * * "hyphen" - the "-" punctuation mark. - * * "period" - the "." punctuation mark. - * * "colon" - the ":" punctuation mark. - * * "longDash" - the "—" punctuation mark. - * * "dash" - the "-" punctuation mark. + * "hyphen" - the "-" punctuation mark. + * "period" - the "." punctuation mark. + * "colon" - the ":" punctuation mark. + * "longDash" - the "—" punctuation mark. + * "dash" - the "-" punctuation mark. * @typedef {("hyphen" | "period" | "colon" | "longDash" | "dash")} CaptionSep - * **/ + */ /** * Possible values for the caption label. * @typedef {("Table" | "Equation" | "Figure")} CaptionLabel - * **/ + */ /** * Table of contents properties. @@ -591,31 +693,41 @@ function ApiWatermarkSettings(oSettings){} /** * Possible values for the table of contents leader: - * * "dot" - "......." - * * "dash" - "-------" - * * "underline" - "_______" + * "dot" - "......." + * "dash" - "-------" + * "underline" - "_______" * @typedef {("dot" | "dash" | "underline" | "none")} TocLeader - * **/ + */ /** * Possible values for the table of contents style. * @typedef {("simple" | "online" | "standard" | "modern" | "classic")} TocStyle - * **/ + */ /** * Possible values for the table of figures style. * @typedef {("simple" | "online" | "classic" | "distinctive" | "centered" | "formal")} TofStyle - * **/ + */ + +/** + * Any valid drawing element. + * @typedef {(ApiShape | ApiImage | ApiGroup | ApiOleObject | ApiChart )} Drawing + */ + +/** + * Available drawing element for grouping. + * @typedef {(ApiShape | ApiGroup | ApiImage | ApiChart)} DrawingForGroup + */ /** * The 1000th of a percent (100000 = 100%). * @typedef {number} PositivePercentage - * */ + */ /** * The type of tick mark appearance. * @typedef {("cross" | "in" | "none" | "out")} TickMark - * */ + */ /** * The watermark type. @@ -624,13 +736,18 @@ function ApiWatermarkSettings(oSettings){} /** * The watermark direction. - * @typedef {("horizontal" | "clockwise45" | "counterclockwise45")} WatermarkDirection + * @typedef {("horizontal" | "clockwise45" | "counterclockwise45" | "clockwise90" | "counterclockwise90")} WatermarkDirection + */ + +/** + * The Base64 image string. + * @typedef {string} Base64Img + * @example "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA..." */ /** * Creates a new paragraph. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE"] * @returns {ApiParagraph} */ ApiInterface.prototype.CreateParagraph = function(){ return new ApiParagraph(); }; @@ -638,7 +755,6 @@ ApiInterface.prototype.CreateParagraph = function(){ return new ApiParagraph(); /** * Creates a new smaller text block to be inserted to the current paragraph or table. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiInterface.prototype.CreateRun = function(){ return new ApiRun(); }; @@ -646,7 +762,6 @@ ApiInterface.prototype.CreateRun = function(){ return new ApiRun(); }; /** * Creates an RGB color setting the appropriate values for the red, green and blue color components. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -657,121 +772,137 @@ ApiInterface.prototype.CreateRGBColor = function(r, g, b){ return new ApiRGBColo /** * Creates a complex color scheme selecting from one of the available schemes. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {SchemeColorId} sSchemeColorId - The color scheme identifier. + * @param {SchemeColorId} schemeColorId - The color scheme identifier. * @returns {ApiSchemeColor} */ -ApiInterface.prototype.CreateSchemeColor = function(sSchemeColorId){ return new ApiSchemeColor(); }; +ApiInterface.prototype.CreateSchemeColor = function(schemeColorId){ return new ApiSchemeColor(); }; /** * Creates a color selecting it from one of the available color presets. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {PresetColor} sPresetColor - A preset selected from the list of the available color preset names. + * @param {PresetColor} presetColor - A preset selected from the list of the available color preset names. * @returns {ApiPresetColor}; - * */ -ApiInterface.prototype.CreatePresetColor = function(sPresetColor){ return new ApiPresetColor(); }; + */ +ApiInterface.prototype.CreatePresetColor = function(presetColor){ return new ApiPresetColor(); }; /** * Creates a solid fill to apply to the object using a selected solid color as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiUniColor} oUniColor - The color used for the element fill. + * @param {ApiUniColor} uniColor - The color used for the element fill. * @returns {ApiFill} - * */ -ApiInterface.prototype.CreateSolidFill = function(oUniColor){ return new ApiFill(); }; + */ +ApiInterface.prototype.CreateSolidFill = function(uniColor){ return new ApiFill(); }; /** * Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} aGradientStop - The array of gradient color stops measured in 1000th of percent. - * @param {PositiveFixedAngle} Angle - The angle measured in 60000th of a degree that will define the gradient direction. + * @param {number[]} gradientStops - The array of gradient color stops measured in 1000th of percent. + * @param {PositiveFixedAngle} angle - The angle measured in 60000th of a degree that will define the gradient direction. * @returns {ApiFill} */ -ApiInterface.prototype.CreateLinearGradientFill = function(aGradientStop, Angle){ return new ApiFill(); }; +ApiInterface.prototype.CreateLinearGradientFill = function(gradientStops, angle){ return new ApiFill(); }; /** * Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} aGradientStop - The array of gradient color stops measured in 1000th of percent. + * @param {number[]} gradientStops - The array of gradient color stops measured in 1000th of percent. * @returns {ApiFill} */ -ApiInterface.prototype.CreateRadialGradientFill = function(aGradientStop){ return new ApiFill(); }; +ApiInterface.prototype.CreateRadialGradientFill = function(gradientStops){ return new ApiFill(); }; /** * Creates a pattern fill to apply to the object using the selected pattern as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {PatternType} sPatternType - The pattern type used for the fill selected from one of the available pattern types. - * @param {ApiUniColor} BgColor - The background color used for the pattern creation. - * @param {ApiUniColor} FgColor - The foreground color used for the pattern creation. + * @param {PatternType} patternType - The pattern type used for the fill selected from one of the available pattern types. + * @param {ApiUniColor} bgColor - The background color used for the pattern creation. + * @param {ApiUniColor} fgColor - The foreground color used for the pattern creation. * @returns {ApiFill} */ -ApiInterface.prototype.CreatePatternFill = function(sPatternType, BgColor, FgColor){ return new ApiFill(); }; +ApiInterface.prototype.CreatePatternFill = function(patternType, bgColor, fgColor){ return new ApiFill(); }; /** * Creates a blip fill to apply to the object using the selected image as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {string} sImageUrl - The path to the image used for the blip fill (currently only internet URL or Base64 encoded images are supported). - * @param {BlipFillType} sBlipFillType - The type of the fill used for the blip fill (tile or stretch). + * @param {string} imageUrl - The path to the image used for the blip fill (currently only internet URL or Base64 encoded images are supported). + * @param {BlipFillType} blipFillType - The type of the fill used for the blip fill (tile or stretch). * @returns {ApiFill} - * */ -ApiInterface.prototype.CreateBlipFill = function(sImageUrl, sBlipFillType){ return new ApiFill(); }; + */ +ApiInterface.prototype.CreateBlipFill = function(imageUrl, blipFillType){ return new ApiFill(); }; /** * Creates no fill and removes the fill from the element. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiFill} - * */ + */ ApiInterface.prototype.CreateNoFill = function(){ return new ApiFill(); }; /** * Creates a stroke adding shadows to the element. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {EMU} nWidth - The width of the shadow measured in English measure units. - * @param {ApiFill} oFill - The fill type used to create the shadow. + * @param {EMU} width - The width of the shadow measured in English measure units. + * @param {ApiFill} fill - The fill type used to create the shadow. * @returns {ApiStroke} - * */ -ApiInterface.prototype.CreateStroke = function(nWidth, oFill){ return new ApiStroke(); }; + */ +ApiInterface.prototype.CreateStroke = function(width, fill){ return new ApiStroke(); }; /** * Creates a gradient stop used for different types of gradients. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiUniColor} oUniColor - The color used for the gradient stop. - * @param {PositivePercentage} nPos - The position of the gradient stop measured in 1000th of percent. + * @param {ApiUniColor} uniColor - The color used for the gradient stop. + * @param {PositivePercentage} pos - The position of the gradient stop measured in 1000th of percent. * @returns {ApiGradientStop} - * */ -ApiInterface.prototype.CreateGradientStop = function(oUniColor, nPos){ return new ApiGradientStop(); }; + */ +ApiInterface.prototype.CreateGradientStop = function(uniColor, pos){ return new ApiGradientStop(); }; /** * Creates a bullet for a paragraph with the character or symbol specified with the sSymbol parameter. * @memberof ApiInterface - * @typeofeditors ["CSE", "CPE"] * @param {string} sSymbol - The character or symbol which will be used to create the bullet for the paragraph. * @returns {ApiBullet} - * */ + */ ApiInterface.prototype.CreateBullet = function(sSymbol){ return new ApiBullet(); }; /** - * Creates a bullet for a paragraph with the numbering character or symbol specified with the sType parameter. + * Creates a bullet for a paragraph with the numbering character or symbol specified with the numType parameter. * @memberof ApiInterface - * @typeofeditors ["CSE", "CPE"] - * @param {BulletType} sType - The numbering type the paragraphs will be numbered with. - * @param {number} nStartAt - The number the first numbered paragraph will start with. + * @param {BulletType} numType - The numbering type the paragraphs will be numbered with. + * @param {number} startAt - The number the first numbered paragraph will start with. * @returns {ApiBullet} - * */ -ApiInterface.prototype.CreateNumbering = function(sType, nStartAt){ return new ApiBullet(); }; + */ +ApiInterface.prototype.CreateNumbering = function(numType, startAt){ return new ApiBullet(); }; + +/** + * The checkbox content control properties + * @typedef {Object} ContentControlCheckBoxPr + * @property {boolean} [checked] Indicates whether the checkbox is checked by default. + * @property {string} [checkedSymbol] A custom symbol to display when the checkbox is checked (e.g., "в�’"). + * @property {string} [uncheckedSymbol] A custom symbol to display when the checkbox is unchecked (e.g., "в�ђ"). + */ + +/** + * The object representing the items in the combo box or drop-down list. + * @typedef {Object} ContentControlListItem + * @property {string} display - The text to be displayed in the combo box or drop-down list. + * @property {string} value - The value associated with the item. + */ + +/** + * The date picker content control properties. + * @typedef {Object} ContentControlDatePr + * @property {string} format - The date format. Example: "mm.dd.yyyy". + * @property {string} lang - The date language. Possible value for this parameter is a language identifier as defined by + * RFC 4646/BCP 47. Example: "en-CA". + */ + +/** + * Returns a type of the ApiUnsupported class. + * @returns {"unsupported"} + */ +ApiUnsupported.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the ApiDocumentContent class. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"documentContent"} */ ApiDocumentContent.prototype.GetClassType = function(){ return ""; }; @@ -779,7 +910,6 @@ ApiDocumentContent.prototype.GetClassType = function(){ return ""; }; /** * Returns a number of elements in the current document. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {number} */ ApiDocumentContent.prototype.GetElementsCount = function(){ return 0; }; @@ -788,7 +918,6 @@ ApiDocumentContent.prototype.GetElementsCount = function(){ return 0; }; * Returns an element by its position in the document. * @memberof ApiDocumentContent * @param {number} nPos - The element position that will be taken from the document. - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {DocumentElement} */ ApiDocumentContent.prototype.GetElement = function(nPos){ return new DocumentElement(); }; @@ -796,16 +925,15 @@ ApiDocumentContent.prototype.GetElement = function(nPos){ return new DocumentEle /** * Adds a paragraph or a table or a blockLvl content control using its position in the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The position where the current element will be added. * @param {DocumentElement} oElement - The document element which will be added at the current position. + * @returns {boolean} */ -ApiDocumentContent.prototype.AddElement = function(nPos, oElement){}; +ApiDocumentContent.prototype.AddElement = function(nPos, oElement){ return true; }; /** * Pushes a paragraph or a table to actually add it to the document. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {DocumentElement} oElement - The element type which will be pushed to the document. * @returns {boolean} - returns false if oElement is unsupported. */ @@ -816,46 +944,60 @@ ApiDocumentContent.prototype.Push = function(oElement){ return true; }; * When all elements are removed, a new empty paragraph is automatically created. If you want to add * content to this paragraph, use the {@link ApiDocumentContent#GetElement} method. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiDocumentContent.prototype.RemoveAllElements = function(){}; +ApiDocumentContent.prototype.RemoveAllElements = function(){ return true; }; /** * Removes an element using the position specified. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The element number (position) in the document or inside other element. + * @returns {boolean} */ -ApiDocumentContent.prototype.RemoveElement = function(nPos){}; +ApiDocumentContent.prototype.RemoveElement = function(nPos){ return true; }; /** - * Creates a new history point. - * @memberof ApiDocument + * Represents an attribute of an XML node. + * @typedef {Object} CustomXmlNodeAttribute + * @property {string} name - The attribute name. + * @property {string} value - The attribute value. */ -ApiDocument.prototype.CreateNewHistoryPoint = function(){}; /** - * Record of one comment. + * Represents a single comment record. * @typedef {Object} CommentReportRecord - * @property {boolean} [IsAnswer=false] - Specifies whether this is an initial comment or a reply to another comment. - * @property {string} CommentMessage - The text of the current comment. - * @property {number} Date - The time when this change was made in local time. - * @property {number} DateUTC - The time when this change was made in UTC. - * @property {string} [QuoteText=undefined] - The text to which this comment is related. + * @property {boolean} IsAnswer Specifies whether the comment is a response. + * @property {string} CommentMessage The comment text. + * @property {number} Date The comment local timestamp. + * @property {number} DateUTC The comment UTC timestamp. + * @property {string} [QuoteText] The quoted text (if available). */ /** - * Report on all comments. - * This is a dictionary where the keys are usernames. - * @typedef {Object.>} CommentReport + * Represents a user's comment history. + * @typedef {Object} UserComments + * @property {CommentReportRecord[]} comments A list of comments. + */ + +/** + * A dictionary of users and their comments. + * @typedef {Object} CommentReport + * @property {UserComments} [username] The comments grouped by username. * @example - * { - * "John Smith" : [{IsAnswer: false, CommentMessage: 'Good text', Date: 1688588002698, DateUTC: 1688570002698, QuoteText: 'Some text'}, - * {IsAnswer: true, CommentMessage: "I don't think so", Date: 1688588012661, DateUTC: 1688570012661}], - * - * "Mark Pottato" : [{IsAnswer: false, CommentMessage: 'Need to change this part', Date: 1688587967245, DateUTC: 1688569967245, QuoteText: 'The quick brown fox jumps over the lazy dog'}, - * {IsAnswer: false, CommentMessage: 'We need to add a link', Date: 1688587967245, DateUTC: 1688569967245, QuoteText: 'OnlyOffice'}] - * } + * { + * "John Smith": { + * comments: [ + * { IsAnswer: false, CommentMessage: "Good text", Date: 1688588002698, DateUTC: 1688570002698, QuoteText: "Some text" }, + * { IsAnswer: true, CommentMessage: "I don't think so", Date: 1688588012661, DateUTC: 1688570012661 } + * ] + * }, + * "Mark Pottato": { + * comments: [ + * { IsAnswer: false, CommentMessage: "Need to change this part", Date: 1688587967245, DateUTC: 1688569967245, QuoteText: "The quick brown fox jumps over the lazy dog" }, + * { IsAnswer: false, CommentMessage: "We need to add a link", Date: 1688587967245, DateUTC: 1688569967245, QuoteText: "OnlyOffice" } + * ] + * } + * } */ /** @@ -864,23 +1006,38 @@ ApiDocument.prototype.CreateNewHistoryPoint = function(){}; */ /** - * Record of one review change. + * Represents a single review change record. * @typedef {Object} ReviewReportRecord - * @property {ReviewReportRecordType} Type - Review record type. - * @property {string} [Value=undefined] - Review change value that is set for the "TextAdd" and "TextRem" types only. - * @property {number} Date - The time when this change was made. + * @property {ReviewReportRecordType} Type The review record type. + * @property {string} [Value] The review change value (only for "TextAdd" and "TextRem" types). + * @property {number} Date The timestamp of the change. + * @property {ApiParagraph | ApiTable} ReviewedElement The element that was reviewed. */ /** - * Report on all review changes. - * This is a dictionary where the keys are usernames. - * @typedef {Object.>} ReviewReport + * Represents a user's review history. + * @typedef {Object} UserReviewChanges + * @property {ReviewReportRecord[]} reviews A list of review records. + */ + +/** + * A dictionary of users and their review changes. + * @typedef {Object} ReviewReport + * @property {UserReviewChanges} [username] The review changes grouped by username. * @example * { - * "John Smith" : [{Type: 'TextRem', Value: 'Hello, Mark!', Date: 1679941734161}, - * {Type: 'TextAdd', Value: 'Dear Mr. Pottato.', Date: 1679941736189}], - * "Mark Pottato" : [{Type: 'ParaRem', Date: 1679941755942}, - * {Type: 'TextPr', Date: 1679941757832}] + * "John Smith": { + * reviews: [ + * { Type: "TextRem", Value: "Hello, Mark!", Date: 1679941734161, ReviewedElement: ApiParagraph }, + * { Type: "TextAdd", Value: "Dear Mr. Pottato.", Date: 1679941736189, ReviewedElement: ApiParagraph } + * ] + * }, + * "Mark Pottato": { + * reviews: [ + * { Type: "ParaRem", Date: 1679941755942, ReviewedElement: ApiParagraph }, + * { Type: "TextPr", Date: 1679941757832, ReviewedElement: ApiParagraph } + * ] + * } * } */ @@ -908,7 +1065,6 @@ ApiDocument.prototype.CreateNewHistoryPoint = function(){}; /** * Returns a type of the ApiParagraph class. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"paragraph"} */ ApiParagraph.prototype.GetClassType = function(){ return ""; }; @@ -916,7 +1072,6 @@ ApiParagraph.prototype.GetClassType = function(){ return ""; }; /** * Adds some text to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} [sText=""] - The text that we want to insert into the current document element. * @returns {ApiRun} */ @@ -925,7 +1080,6 @@ ApiParagraph.prototype.AddText = function(sText){ return new ApiRun(); }; /** * Adds a line break to the current position and starts the next element from a new line. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddLineBreak = function(){ return new ApiRun(); }; @@ -933,7 +1087,6 @@ ApiParagraph.prototype.AddLineBreak = function(){ return new ApiRun(); }; /** * Returns the paragraph properties. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParaPr} */ ApiParagraph.prototype.GetParaPr = function(){ return new ApiParaPr(); }; @@ -941,7 +1094,6 @@ ApiParagraph.prototype.GetParaPr = function(){ return new ApiParaPr(); }; /** * Returns a number of elements in the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {number} */ ApiParagraph.prototype.GetElementsCount = function(){ return 0; }; @@ -949,7 +1101,6 @@ ApiParagraph.prototype.GetElementsCount = function(){ return 0; }; /** * Returns a paragraph element using the position specified. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The position where the element which content we want to get must be located. * @returns {ParagraphContent} */ @@ -961,24 +1112,23 @@ ApiParagraph.prototype.GetElement = function(nPos){ return new ParagraphContent( * a new empty run is automatically created. If you want to add * content to this run, use the {@link ApiParagraph#GetElement} method. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The element position which we want to remove from the paragraph. + * @returns {boolean} */ -ApiParagraph.prototype.RemoveElement = function(nPos){}; +ApiParagraph.prototype.RemoveElement = function(nPos){ return true; }; /** * Removes all the elements from the current paragraph. * When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add * content to this run, use the {@link ApiParagraph#GetElement} method. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiParagraph.prototype.RemoveAllElements = function(){}; +ApiParagraph.prototype.RemoveAllElements = function(){ return true; }; /** * Deletes the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} - returns false if paragraph haven't parent. */ ApiParagraph.prototype.Delete = function(){ return true; }; @@ -986,7 +1136,6 @@ ApiParagraph.prototype.Delete = function(){ return true; }; /** * Returns the next paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph | null} - returns null if paragraph is last. */ ApiParagraph.prototype.GetNext = function(){ return new ApiParagraph(); }; @@ -994,7 +1143,6 @@ ApiParagraph.prototype.GetNext = function(){ return new ApiParagraph(); }; /** * Returns the previous paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph} - returns null if paragraph is first. */ ApiParagraph.prototype.GetPrevious = function(){ return new ApiParagraph(); }; @@ -1002,7 +1150,6 @@ ApiParagraph.prototype.GetPrevious = function(){ return new ApiParagraph(); }; /** * Creates a paragraph copy. Ingnore comments, footnote references, complex fields. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph} */ ApiParagraph.prototype.Copy = function(){ return new ApiParagraph(); }; @@ -1010,7 +1157,6 @@ ApiParagraph.prototype.Copy = function(){ return new ApiParagraph(); }; /** * Adds an element to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ParagraphContent} oElement - The document element which will be added at the current position. Returns false if the * oElement type is not supported by a paragraph. * @param {number} [nPos] - The position where the current element will be added. If this value is not @@ -1023,7 +1169,6 @@ ApiParagraph.prototype.AddElement = function(oElement, nPos){ return true; }; /** * Adds a tab stop to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddTabStop = function(){ return new ApiRun(); }; @@ -1031,7 +1176,6 @@ ApiParagraph.prototype.AddTabStop = function(){ return new ApiRun(); }; /** * Returns a type of the ApiRun class. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"run"} */ ApiRun.prototype.GetClassType = function(){ return ""; }; @@ -1039,7 +1183,6 @@ ApiRun.prototype.GetClassType = function(){ return ""; }; /** * Returns the text properties of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiTextPr} */ ApiRun.prototype.GetTextPr = function(){ return new ApiTextPr(); }; @@ -1047,50 +1190,49 @@ ApiRun.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** * Clears the content from the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.ClearContent = function(){}; +ApiRun.prototype.ClearContent = function(){ return true; }; /** * Removes all the elements from the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.RemoveAllElements = function(){}; +ApiRun.prototype.RemoveAllElements = function(){ return true; }; /** * Deletes the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.Delete = function(){}; +ApiRun.prototype.Delete = function(){ return true; }; /** * Adds some text to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sText - The text which will be added to the current run. + * @returns {boolean} */ -ApiRun.prototype.AddText = function(sText){}; +ApiRun.prototype.AddText = function(sText){ return true; }; /** * Adds a line break to the current run position and starts the next element from a new line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.AddLineBreak = function(){}; +ApiRun.prototype.AddLineBreak = function(){ return true; }; /** * Adds a tab stop to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.AddTabStop = function(){}; +ApiRun.prototype.AddTabStop = function(){ return true; }; /** * Creates a copy of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiRun.prototype.Copy = function(){ return new ApiRun(); }; @@ -1098,7 +1240,6 @@ ApiRun.prototype.Copy = function(){ return new ApiRun(); }; /** * Sets the text properties to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ApiTextPr} oTextPr - The text properties that will be set to the current run. * @returns {ApiTextPr} */ @@ -1107,7 +1248,6 @@ ApiRun.prototype.SetTextPr = function(oTextPr){ return new ApiTextPr(); }; /** * Sets the bold property to the text character. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isBold - Specifies that the contents of the current run are displayed bold. * @returns {ApiTextPr} */ @@ -1116,7 +1256,6 @@ ApiRun.prototype.SetBold = function(isBold){ return new ApiTextPr(); }; /** * Specifies that any lowercase characters in the current text run are formatted for display only as their capital letter character equivalents. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isCaps - Specifies that the contents of the current run are displayed capitalized. * @returns {ApiTextPr} */ @@ -1125,7 +1264,6 @@ ApiRun.prototype.SetCaps = function(isCaps){ return new ApiTextPr(); }; /** * Sets the text color for the current text run in the RGB format. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -1137,7 +1275,6 @@ ApiRun.prototype.SetColor = function(r, g, b, isAuto){ return new ApiTextPr(); } /** * Specifies that the contents of the current run are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isDoubleStrikeout - Specifies that the contents of the current run are displayed double struck through. * @returns {ApiTextPr} */ @@ -1146,7 +1283,6 @@ ApiRun.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return new Ap /** * Sets the text color to the current text run. * @memberof ApiRun - * @typeofeditors ["CSE", "CPE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the text color. * @returns {ApiTextPr} */ @@ -1155,7 +1291,6 @@ ApiRun.prototype.SetFill = function(oApiFill){ return new ApiTextPr(); }; /** * Sets all 4 font slots with the specified font family. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sFontFamily - The font family or families used for the current text run. * @returns {ApiTextPr} */ @@ -1164,7 +1299,6 @@ ApiRun.prototype.SetFontFamily = function(sFontFamily){ return new ApiTextPr(); /** * Returns all font names from all elements inside the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {string[]} - The font names used for the current run. */ ApiRun.prototype.GetFontNames = function(){ return [""]; }; @@ -1172,7 +1306,6 @@ ApiRun.prototype.GetFontNames = function(){ return [""]; }; /** * Sets the font size to the characters of the current text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiTextPr} */ @@ -1181,7 +1314,6 @@ ApiRun.prototype.SetFontSize = function(nSize){ return new ApiTextPr(); }; /** * Specifies a highlighting color which is applied as a background to the contents of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiTextPr} */ @@ -1190,7 +1322,6 @@ ApiRun.prototype.SetHighlight = function(sColor){ return new ApiTextPr(); }; /** * Sets the italic property to the text character. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isItalic - Specifies that the contents of the current run are displayed italicized. * @returns {ApiTextPr} */ @@ -1200,7 +1331,6 @@ ApiRun.prototype.SetItalic = function(isItalic){ return new ApiTextPr(); }; * Specifies the languages which will be used to check spelling and grammar (if requested) when processing * the contents of this text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sLangId - The possible value for this parameter is a language identifier as defined by * RFC 4646/BCP 47. Example: "en-CA". * @returns {ApiTextPr} @@ -1211,7 +1341,6 @@ ApiRun.prototype.SetLanguage = function(sLangId){ return new ApiTextPr(); }; * Specifies an amount by which text is raised or lowered for this run in relation to the default * baseline of the surrounding non-positioned text. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nPosition - Specifies a positive (raised text) or negative (lowered text) * measurement in half-points (1/144 of an inch). * @returns {ApiTextPr} @@ -1221,7 +1350,6 @@ ApiRun.prototype.SetPosition = function(nPosition){ return new ApiTextPr(); }; /** * Specifies the shading applied to the contents of the current text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ShdType} sType - The shading type applied to the contents of the current text run. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. @@ -1234,7 +1362,6 @@ ApiRun.prototype.SetShd = function(sType, r, g, b){ return new ApiTextPr(); }; * Specifies that all the small letter characters in this text run are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current run are displayed capitalized two points smaller or not. * @returns {ApiTextPr} */ @@ -1243,7 +1370,6 @@ ApiRun.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiTextPr(); } /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiTextPr} */ @@ -1252,26 +1378,15 @@ ApiRun.prototype.SetSpacing = function(nSpacing){ return new ApiTextPr(); }; /** * Specifies that the contents of the current run are displayed with a single horizontal line through the center of the line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isStrikeout - Specifies that the contents of the current run are displayed struck through. * @returns {ApiTextPr} */ ApiRun.prototype.SetStrikeout = function(isStrikeout){ return new ApiTextPr(); }; -/** - * Sets a style to the current run. - * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiStyle} oStyle - The style which must be applied to the text run. - * @returns {ApiTextPr} - */ -ApiRun.prototype.SetStyle = function(oStyle){ return new ApiTextPr(); }; - /** * Specifies that the contents of the current run are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isUnderline - Specifies that the contents of the current run are displayed underlined. * @returns {ApiTextPr} */ @@ -1279,20 +1394,32 @@ ApiRun.prototype.SetUnderline = function(isUnderline){ return new ApiTextPr(); } /** * Specifies the alignment which will be applied to the contents of the current run in relation to the default appearance of the text run: - * * "baseline" - the characters in the current text run will be aligned by the default text baseline. - * * "subscript" - the characters in the current text run will be aligned below the default text baseline. - * * "superscript" - the characters in the current text run will be aligned above the default text baseline. + * "baseline" - the characters in the current text run will be aligned by the default text baseline. + * "subscript" - the characters in the current text run will be aligned below the default text baseline. + * "superscript" - the characters in the current text run will be aligned above the default text baseline. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiTextPr} */ ApiRun.prototype.SetVertAlign = function(sType){ return new ApiTextPr(); }; +/** + * The section break type which defines how the contents of the current section are placed relative to the previous section. + * WordprocessingML supports five distinct types of section breaks: + * Next page ("nextPage") - starts a new section on the next page (the default value). + * Odd ("oddPage") - starts a new section on the next odd-numbered page. + * Even ("evenPage") - starts a new section on the next even-numbered page. + * Continuous ("continuous") - starts a new section in the next paragraph. + * This means that continuous section breaks might not specify certain page-level section properties, + * since they shall be inherited from the following section. + * However, these breaks can specify other section properties, such as line numbering and footnote/endnote settings. + * Column ("nextColumn") - starts a new section in the next column on the page. + * @typedef {("nextPage" | "oddPage" | "evenPage" | "continuous" | "nextColumn")} SectionBreakType +*/ + /** * Returns a type of the ApiTextPr class. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"textPr"} */ ApiTextPr.prototype.GetClassType = function(){ return ""; }; @@ -1300,7 +1427,6 @@ ApiTextPr.prototype.GetClassType = function(){ return ""; }; /** * Sets the bold property to the text character. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isBold - Specifies that the contents of the run are displayed bold. * @returns {ApiTextPr} - this text properties. */ @@ -1309,7 +1435,6 @@ ApiTextPr.prototype.SetBold = function(isBold){ return new ApiTextPr(); }; /** * Gets the bold property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1318,7 +1443,6 @@ ApiTextPr.prototype.GetBold = function(){ return true; }; /** * Sets the italic property to the text character. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isItalic - Specifies that the contents of the current run are displayed italicized. * @returns {ApiTextPr} - this text properties. */ @@ -1327,7 +1451,6 @@ ApiTextPr.prototype.SetItalic = function(isItalic){ return new ApiTextPr(); }; /** * Gets the italic property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1336,7 +1459,6 @@ ApiTextPr.prototype.GetItalic = function(){ return true; }; /** * Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isStrikeout - Specifies that the contents of the current run are displayed struck through. * @returns {ApiTextPr} - this text properties. */ @@ -1345,7 +1467,6 @@ ApiTextPr.prototype.SetStrikeout = function(isStrikeout){ return new ApiTextPr() /** * Gets the strikeout property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1355,7 +1476,6 @@ ApiTextPr.prototype.GetStrikeout = function(){ return true; }; * Specifies that the contents of the run are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isUnderline - Specifies that the contents of the current run are displayed underlined. * @returns {ApiTextPr} - this text properties. */ @@ -1364,7 +1484,6 @@ ApiTextPr.prototype.SetUnderline = function(isUnderline){ return new ApiTextPr() /** * Gets the underline property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1373,25 +1492,25 @@ ApiTextPr.prototype.GetUnderline = function(){ return true; }; /** * Sets all 4 font slots with the specified font family. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sFontFamily - The font family or families used for the current text run. * @returns {ApiTextPr} - this text properties. */ ApiTextPr.prototype.SetFontFamily = function(sFontFamily){ return new ApiTextPr(); }; /** - * Gets the font family from the current text properties. + * Returns the font family from the current text properties. + * The method automatically calculates the font from the theme if the font was set via the theme. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] + * param {undefined | "ascii" | "eastAsia" | "hAnsi" | "cs"} [fontSlot="ascii"] - The font slot. + * If this parameter is not specified, the "ascii" value is used. * @returns {string} * @since 8.1.0 */ -ApiTextPr.prototype.GetFontFamily = function(){ return ""; }; +ApiTextPr.prototype.GetFontFamily = function(fontSlot){ return ""; }; /** * Sets the font size to the characters of the current text run. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiTextPr} - this text properties. */ @@ -1400,7 +1519,6 @@ ApiTextPr.prototype.SetFontSize = function(nSize){ return new ApiTextPr(); }; /** * Gets the font size from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {hps} * @since 8.1.0 */ @@ -1408,11 +1526,10 @@ ApiTextPr.prototype.GetFontSize = function(){ return new hps(); }; /** * Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text: - * * "baseline" - the characters in the current text run will be aligned by the default text baseline. - * * "subscript" - the characters in the current text run will be aligned below the default text baseline. - * * "superscript" - the characters in the current text run will be aligned above the default text baseline. + * "baseline" - the characters in the current text run will be aligned by the default text baseline. + * "subscript" - the characters in the current text run will be aligned below the default text baseline. + * "superscript" - the characters in the current text run will be aligned above the default text baseline. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiTextPr} - this text properties. */ @@ -1421,7 +1538,6 @@ ApiTextPr.prototype.SetVertAlign = function(sType){ return new ApiTextPr(); }; /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiTextPr} - this text properties. */ @@ -1430,7 +1546,6 @@ ApiTextPr.prototype.SetSpacing = function(nSpacing){ return new ApiTextPr(); }; /** * Gets the text spacing from the current text properties measured in twentieths of a point. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} * @since 8.1.0 */ @@ -1439,7 +1554,6 @@ ApiTextPr.prototype.GetSpacing = function(){ return new twips(); }; /** * Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isDoubleStrikeout - Specifies that the contents of the current run are displayed double struck through. * @returns {ApiTextPr} - this text properties. */ @@ -1448,7 +1562,6 @@ ApiTextPr.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return new /** * Gets the double strikeout property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1457,7 +1570,6 @@ ApiTextPr.prototype.GetDoubleStrikeout = function(){ return true; }; /** * Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isCaps - Specifies that the contents of the current run are displayed capitalized. * @returns {ApiTextPr} - this text properties. */ @@ -1466,7 +1578,6 @@ ApiTextPr.prototype.SetCaps = function(isCaps){ return new ApiTextPr(); }; /** * Specifies whether the text with the current text properties are capitalized. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1476,7 +1587,6 @@ ApiTextPr.prototype.GetCaps = function(){ return true; }; * Specifies that all the small letter characters in the text run are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current run are displayed capitalized two points smaller or not. * @returns {ApiTextPr} - this text properties. */ @@ -1485,7 +1595,6 @@ ApiTextPr.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiTextPr() /** * Specifies whether the text with the current text properties are displayed capitalized two points smaller than the actual font size. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1494,7 +1603,6 @@ ApiTextPr.prototype.GetSmallCaps = function(){ return true; }; /** * Sets the text color to the current text run. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the text color. * @returns {ApiTextPr} - this text properties. */ @@ -1503,7 +1611,6 @@ ApiTextPr.prototype.SetFill = function(oApiFill){ return new ApiTextPr(); }; /** * Gets the text color from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @returns {ApiFill} * @since 8.1.0 */ @@ -1512,7 +1619,6 @@ ApiTextPr.prototype.GetFill = function(){ return new ApiFill(); }; /** * Sets the text fill to the current text run. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE", "CSE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the text color. * @returns {ApiTextPr} - this text properties. */ @@ -1521,7 +1627,6 @@ ApiTextPr.prototype.SetTextFill = function(oApiFill){ return new ApiTextPr(); }; /** * Gets the text fill from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @returns {ApiFill} * @since 8.1.0 */ @@ -1530,7 +1635,6 @@ ApiTextPr.prototype.GetTextFill = function(){ return new ApiFill(); }; /** * Sets the text outline to the current text run. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the text outline. * @returns {ApiTextPr} - this text properties. */ @@ -1539,7 +1643,6 @@ ApiTextPr.prototype.SetOutLine = function(oStroke){ return new ApiTextPr(); }; /** * Gets the text outline from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @returns {ApiStroke} * @since 8.1.0 */ @@ -1548,7 +1651,6 @@ ApiTextPr.prototype.GetOutLine = function(){ return new ApiStroke(); }; /** * Returns a type of the ApiParaPr class. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"paraPr"} */ ApiParaPr.prototype.GetClassType = function(){ return ""; }; @@ -1556,15 +1658,14 @@ ApiParaPr.prototype.GetClassType = function(){ return ""; }; /** * Sets the paragraph left side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph left side indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndLeft = function(nValue){}; +ApiParaPr.prototype.SetIndLeft = function(nValue){ return true; }; /** * Returns the paragraph left side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph left side indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndLeft = function(){ return new twips(); }; @@ -1572,15 +1673,14 @@ ApiParaPr.prototype.GetIndLeft = function(){ return new twips(); }; /** * Sets the paragraph right side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph right side indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndRight = function(nValue){}; +ApiParaPr.prototype.SetIndRight = function(nValue){ return true; }; /** * Returns the paragraph right side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph right side indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndRight = function(){ return new twips(); }; @@ -1588,15 +1688,14 @@ ApiParaPr.prototype.GetIndRight = function(){ return new twips(); }; /** * Sets the paragraph first line indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph first line indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndFirstLine = function(nValue){}; +ApiParaPr.prototype.SetIndFirstLine = function(nValue){ return true; }; /** * Returns the paragraph first line indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph first line indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndFirstLine = function(){ return new twips(); }; @@ -1604,16 +1703,15 @@ ApiParaPr.prototype.GetIndFirstLine = function(){ return new twips(); }; /** * Sets the paragraph contents justification. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("left" | "right" | "both" | "center")} sJc - The justification type that * will be applied to the paragraph contents. + * @returns {boolean} */ -ApiParaPr.prototype.SetJc = function(sJc){}; +ApiParaPr.prototype.SetJc = function(sJc){ return true; }; /** * Returns the paragraph contents justification. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {("left" | "right" | "both" | "center" | undefined)} */ ApiParaPr.prototype.GetJc = function(){ return ""; }; @@ -1624,16 +1722,15 @@ ApiParaPr.prototype.GetJc = function(){ return ""; }; * the value of the sLineRule parameter is "auto", then the value of the * nLine parameter will be interpreted as 240ths of a line. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {(twips | line240)} nLine - The line spacing value measured either in twentieths of a point (1/1440 of an inch) or in 240ths of a line. * @param {("auto" | "atLeast" | "exact")} sLineRule - The rule that determines the measuring units of the line spacing. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingLine = function(nLine, sLineRule){}; +ApiParaPr.prototype.SetSpacingLine = function(nLine, sLineRule){ return true; }; /** * Returns the paragraph line spacing value. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | line240 | undefined} - to know is twips or line240 use ApiParaPr.prototype.GetSpacingLineRule(). */ ApiParaPr.prototype.GetSpacingLineValue = function(){ return new twips(); }; @@ -1641,7 +1738,6 @@ ApiParaPr.prototype.GetSpacingLineValue = function(){ return new twips(); }; /** * Returns the paragraph line spacing rule. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"auto" | "atLeast" | "exact" | undefined} */ ApiParaPr.prototype.GetSpacingLineRule = function(){ return ""; }; @@ -1651,16 +1747,15 @@ ApiParaPr.prototype.GetSpacingLineRule = function(){ return ""; }; * any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then * it will be interpreted as false. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nBefore - The value of the spacing before the current paragraph measured in twentieths of a point (1/1440 of an inch). * @param {boolean} [isBeforeAuto=false] - The true value disables the spacing before the current paragraph. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingBefore = function(nBefore, isBeforeAuto){}; +ApiParaPr.prototype.SetSpacingBefore = function(nBefore, isBeforeAuto){ return true; }; /** * Returns the spacing before value of the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} - The value of the spacing before the current paragraph measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetSpacingBefore = function(){ return new twips(); }; @@ -1670,16 +1765,15 @@ ApiParaPr.prototype.GetSpacingBefore = function(){ return new twips(); }; * any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it * will be interpreted as false. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nAfter - The value of the spacing after the current paragraph measured in twentieths of a point (1/1440 of an inch). * @param {boolean} [isAfterAuto=false] - The true value disables the spacing after the current paragraph. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingAfter = function(nAfter, isAfterAuto){}; +ApiParaPr.prototype.SetSpacingAfter = function(nAfter, isAfterAuto){ return true; }; /** * Returns the spacing after value of the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} - The value of the spacing after the current paragraph measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetSpacingAfter = function(){ return new twips(); }; @@ -1688,26 +1782,396 @@ ApiParaPr.prototype.GetSpacingAfter = function(){ return new twips(); }; * Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph. * Warning: The lengths of aPos array and aVal array MUST BE equal to each other. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips[]} aPos - An array of the positions of custom tab stops with respect to the current page margins * measured in twentieths of a point (1/1440 of an inch). * @param {TabJc[]} aVal - An array of the styles of custom tab stops, which determines the behavior of the tab * stop and the alignment which will be applied to text entered at the current custom tab stop. + * @returns {boolean} */ -ApiParaPr.prototype.SetTabs = function(aPos, aVal){}; +ApiParaPr.prototype.SetTabs = function(aPos, aVal){ return true; }; /** * Sets the bullet or numbering to the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CSE", "CPE"] * @param {?ApiBullet} oBullet - The bullet object created with the {@link Api#CreateBullet} or {@link Api#CreateNumbering} method. */ ApiParaPr.prototype.SetBullet = function(oBullet){}; +/** + * Sets the outline level for the specified properties. + * @memberof ApiParaPr + * @param {Number} [nLvl=undefined] - The outline level. Possible values: 0-8. The 0 value means the basic outline level. + * To set no outline level, use this method without a parameter. + * @returns {boolean} + * @since 8.2.0 + */ +ApiParaPr.prototype.SetOutlineLvl = function(nLvl){ return true; }; + +/** + * Returns the outline level of the specified properties. + * @memberof ApiParaPr + * @returns {Number} + * @since 8.2.0 + */ +ApiParaPr.prototype.GetOutlineLvl = function(){ return 0; }; + +/** + * Returns a type of the ApiChart class. + * @memberof ApiChart + * @returns {"chart"} + */ +ApiChart.prototype.GetClassType = function(){ return ""; }; + +/** + * Returns a type of the chart object. + * @memberof ApiChart + * @returns {ChartType} + */ +ApiChart.prototype.GetChartType = function(){ return new ChartType(); }; + +/** + * Specifies the chart title. + * @memberof ApiChart + * @param {string} sTitle - The title which will be displayed for the current chart. + * @param {pt} nFontSize - The text size value measured in points. + * @param {boolean} bIsBold - Specifies if the chart title is written in bold font or not. + * @returns {boolean} + */ +ApiChart.prototype.SetTitle = function (sTitle, nFontSize, bIsBold){ return true; }; + +/** + * Specifies the chart horizontal axis title. + * @memberof ApiChart + * @param {string} sTitle - The title which will be displayed for the horizontal axis of the current chart. + * @param {pt} nFontSize - The text size value measured in points. + * @param {boolean} bIsBold - Specifies if the horizontal axis title is written in bold font or not. + *@returns {boolean} + */ +ApiChart.prototype.SetHorAxisTitle = function (sTitle, nFontSize, bIsBold){ return true; }; + +/** + * Specifies the chart vertical axis title. + * @memberof ApiChart + * @param {string} sTitle - The title which will be displayed for the vertical axis of the current chart. + * @param {pt} nFontSize - The text size value measured in points. + * @param {boolean} bIsBold - Specifies if the vertical axis title is written in bold font or not. + *@returns {boolean} + */ +ApiChart.prototype.SetVerAxisTitle = function (sTitle, nFontSize, bIsBold){ return true; }; + +/** + * Specifies the vertical axis orientation. + * @memberof ApiChart + * @param {boolean} bIsMinMax - The true value will set the normal data direction for the vertical axis (from minimum to maximum). + * @returns {boolean} + */ +ApiChart.prototype.SetVerAxisOrientation = function(bIsMinMax){ return true; }; + +/** + * Specifies the horizontal axis orientation. + * @memberof ApiChart + * @param {boolean} bIsMinMax - The true value will set the normal data direction for the horizontal axis (from minimum to maximum). + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisOrientation = function(bIsMinMax){ return true; }; + +/** + * Specifies the chart legend position. + * @memberof ApiChart + * @param {"left" | "top" | "right" | "bottom" | "none"} sLegendPos - The position of the chart legend inside the chart window. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendPos = function(sLegendPos){ return true; }; + +/** + * Specifies the legend font size. + * @memberof ApiChart + * @param {pt} nFontSize - The text size value measured in points. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendFontSize = function(nFontSize){ return true; }; + +/** + * Specifies which chart data labels are shown for the chart. + * @memberof ApiChart + * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. + * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. + * @param {boolean} bShowVal - Whether to show or hide the chart data values. + * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). + * @returns {boolean} + */ +ApiChart.prototype.SetShowDataLabels = function(bShowSerName, bShowCatName, bShowVal, bShowPercent){ return true; }; + +/** + * Spicifies the show options for data labels. + * @memberof ApiChart + * @param {number} nSeriesIndex - The series index from the array of the data used to build the chart from. + * @param {number} nPointIndex - The point index from this series. + * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. + * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. + * @param {boolean} bShowVal - Whether to show or hide the chart data values. + * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). + * @returns {boolean} + */ +ApiChart.prototype.SetShowPointDataLabel = function(nSeriesIndex, nPointIndex, bShowSerName, bShowCatName, bShowVal, bShowPercent){ return true; }; + +/** + * Spicifies tick labels position for the vertical axis. + * @memberof ApiChart + * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart vertical tick labels. + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisTickLabelPosition = function(sTickLabelPosition){ return true; }; + +/** + * Spicifies tick labels position for the horizontal axis. + * @memberof ApiChart + * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart horizontal tick labels. + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisTickLabelPosition = function(sTickLabelPosition){ return true; }; + +/** + * Specifies major tick mark for the horizontal axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisMajorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies minor tick mark for the horizontal axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisMinorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies major tick mark for the vertical axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisMajorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies minor tick mark for the vertical axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisMinorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies major vertical gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMajorVerticalGridlines = function(oStroke){ return true; }; + +/** + * Specifies minor vertical gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMinorVerticalGridlines = function(oStroke){ return true; }; + +/** + * Specifies major horizontal gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMajorHorizontalGridlines = function(oStroke){ return true; }; + +/** + * Specifies minor horizontal gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMinorHorizontalGridlines = function(oStroke){ return true; }; + +/** + * Removes the specified series from the current chart. + * @memberof ApiChart + * @param {number} nSeria - The index of the chart series. + * @returns {boolean} + */ +ApiChart.prototype.RemoveSeria = function(nSeria){ return true; }; + +/** + * Sets a style to the current chart by style ID. + * @memberof ApiChart + * @param nStyleId - One of the styles available in the editor. + * @returns {boolean} + */ +ApiChart.prototype.ApplyChartStyle = function(nStyleId){ return true; }; + +/** + * Sets the fill to the chart plot area. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the plot area. + * @returns {boolean} + */ +ApiChart.prototype.SetPlotAreaFill = function(oFill){ return true; }; + +/** + * Sets the outline to the chart plot area. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the plot area outline. + * @returns {boolean} + */ +ApiChart.prototype.SetPlotAreaOutLine = function(oStroke){ return true; }; + +/** + * Sets the fill to the specified chart series. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the series. + * @param {number} nSeries - The index of the chart series. + * @param {boolean} [bAll=false] - Specifies if the fill will be applied to all series. + * @returns {boolean} + */ +ApiChart.prototype.SetSeriesFill = function(oFill, nSeries, bAll){ return true; }; + +/** + * Sets the outline to the specified chart series. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the series outline. + * @param {number} nSeries - The index of the chart series. + * @param {boolean} [bAll=false] - Specifies if the outline will be applied to all series. + * @returns {boolean} + */ +ApiChart.prototype.SetSeriesOutLine = function(oStroke, nSeries, bAll){ return true; }; + +/** + * Sets the fill to the data point in the specified chart series. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the data point. + * @param {number} nSeries - The index of the chart series. + * @param {number} nDataPoint - The index of the data point in the specified chart series. + * @param {boolean} [bAllSeries=false] - Specifies if the fill will be applied to the specified data point in all series. + * @returns {boolean} + */ +ApiChart.prototype.SetDataPointFill = function(oFill, nSeries, nDataPoint, bAllSeries){ return true; }; + +/** + * Sets the outline to the data point in the specified chart series. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the data point outline. + * @param {number} nSeries - The index of the chart series. + * @param {number} nDataPoint - The index of the data point in the specified chart series. + * @param {boolean} bAllSeries - Specifies if the outline will be applied to the specified data point in all series. + * @returns {boolean} + */ +ApiChart.prototype.SetDataPointOutLine = function(oStroke, nSeries, nDataPoint, bAllSeries){ return true; }; + +/** + * Sets the fill to the marker in the specified chart series. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the marker. + * @param {number} nSeries - The index of the chart series. + * @param {number} nMarker - The index of the marker in the specified chart series. + * @param {boolean} [bAllMarkers=false] - Specifies if the fill will be applied to all markers in the specified chart series. + * @returns {boolean} + */ +ApiChart.prototype.SetMarkerFill = function(oFill, nSeries, nMarker, bAllMarkers){ return true; }; + +/** + * Sets the outline to the marker in the specified chart series. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the marker outline. + * @param {number} nSeries - The index of the chart series. + * @param {number} nMarker - The index of the marker in the specified chart series. + * @param {boolean} [bAllMarkers=false] - Specifies if the outline will be applied to all markers in the specified chart series. + * @returns {boolean} + */ +ApiChart.prototype.SetMarkerOutLine = function(oStroke, nSeries, nMarker, bAllMarkers){ return true; }; + +/** + * Sets the fill to the chart title. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the title. + * @returns {boolean} + */ +ApiChart.prototype.SetTitleFill = function(oFill){ return true; }; + +/** + * Sets the outline to the chart title. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the title outline. + * @returns {boolean} + */ +ApiChart.prototype.SetTitleOutLine = function(oStroke){ return true; }; + +/** + * Sets the fill to the chart legend. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the legend. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendFill = function(oFill){ return true; }; + +/** + * Sets the outline to the chart legend. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the legend outline. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendOutLine = function(oStroke){ return true; }; + +/** + * Sets the specified numeric format to the axis values. + * @memberof ApiChart + * @param {NumFormat | String} sFormat - Numeric format (can be custom format). + * @param {AxisPos} - Axis position in the chart. + * @returns {boolean} + */ +ApiChart.prototype.SetAxieNumFormat = function(sFormat, sAxiePos){ return true; }; + +/** + * Returns all series from the chart space. + * @memberof ApiChart + * @returns {ApiChartSeries[]} + */ +ApiChart.prototype.GetAllSeries = function(){ return [new ApiChartSeries()]; }; + +/** + * Returns the series with a specific index. + * @memberof ApiChart + * @param {number} nIdx - Series index. + * @returns {ApiChartSeries} + */ +ApiChart.prototype.GetSeries = function(nIdx){ return new ApiChartSeries(); }; + +/** + * Returns a type of the ApiChartSeries class. + * @memberof ApiChartSeries + * @returns {"chartSeries"} + */ +ApiChartSeries.prototype.GetClassType = function(){ return ""; }; + +/** + * Tries to change the series type. Returns true if successful. + * @memberof ApiChartSeries + * @param {ChartType} sType - Chart type. + * @returns {boolean} + */ +ApiChartSeries.prototype.ChangeChartType = function(sType){ return true; }; + +/** + * Returns a chart type of the current series. + * @memberof ApiChartSeries + * @returns {ChartType} + */ +ApiChartSeries.prototype.GetChartType = function(){ return new ChartType(); }; + /** * Returns a type of the ApiFill class. * @memberof ApiFill - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"fill"} */ ApiFill.prototype.GetClassType = function(){ return ""; }; @@ -1715,7 +2179,6 @@ ApiFill.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the ApiStroke class. * @memberof ApiStroke - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"stroke"} */ ApiStroke.prototype.GetClassType = function(){ return ""; }; @@ -1723,7 +2186,6 @@ ApiStroke.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the ApiGradientStop class. * @memberof ApiGradientStop - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"gradientStop"} */ ApiGradientStop.prototype.GetClassType = function (){ return ""; }; @@ -1731,7 +2193,6 @@ ApiGradientStop.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiUniColor class. * @memberof ApiUniColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"uniColor"} */ ApiUniColor.prototype.GetClassType = function (){ return ""; }; @@ -1739,7 +2200,6 @@ ApiUniColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiRGBColor class. * @memberof ApiRGBColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"rgbColor"} */ ApiRGBColor.prototype.GetClassType = function (){ return ""; }; @@ -1747,7 +2207,6 @@ ApiRGBColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiSchemeColor class. * @memberof ApiSchemeColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"schemeColor"} */ ApiSchemeColor.prototype.GetClassType = function (){ return ""; }; @@ -1755,7 +2214,6 @@ ApiSchemeColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiPresetColor class. * @memberof ApiPresetColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"presetColor"} */ ApiPresetColor.prototype.GetClassType = function (){ return ""; }; @@ -1763,7 +2221,6 @@ ApiPresetColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiBullet class. * @memberof ApiBullet - * @typeofeditors ["CSE", "CPE"] * @returns {"bullet"} */ ApiBullet.prototype.GetClassType = function(){ return ""; }; @@ -1771,59 +2228,318 @@ ApiBullet.prototype.GetClassType = function(){ return ""; }; /** * Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} arrString - An array of replacement strings. - * @param {string} [sParaTab=" "] - A character which is used to specify the tab in the source text. - * @param {string} [sParaNewLine=" "] - A character which is used to specify the line break character in the source text. + * @param {string[]} textStrings - An array of replacement strings. + * @param {string} [tab="\t"] - A character which is used to specify the tab in the source text. + * @param {string} [newLine="\r\n"] - A character which is used to specify the line break character in the source text. + * @returns {boolean} */ -ApiInterface.prototype.ReplaceTextSmart = function(arrString, sParaTab, sParaNewLine){}; +ApiInterface.prototype.ReplaceTextSmart = function(textStrings, tab, newLine){ return true; }; /** * Creates the empty text properties. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiTextPr} */ -ApiInterface.prototype.CreateTextPr = function () { return new ApiTextPr(); }; +ApiInterface.prototype.CreateTextPr = function(){ return new ApiTextPr(); }; /** * Returns the full name of the currently opened file. * @memberof ApiInterface - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ -ApiInterface.prototype.GetFullName = function () { return ""; }; +ApiInterface.prototype.GetFullName = function(){ return ""; }; /** * Returns the full name of the currently opened file. * @memberof ApiInterface - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiInterface.prototype.FullName = ApiInterface.prototype.GetFullName (); /** - * В проверке на лок, которую мы делаем после выполнения скрипта, нужно различать действия сделанные через - * разрешенные методы, и действия, которые пользователь пытался сам сделать с формами - * @param fn - * @param t - * @returns {*} + * Returns a type of the ApiCore class. + * @memberof ApiCore + * @returns {"core"} + * @since 9.0.0 */ -function executeNoFormLockCheck(fn, t){ return null; } +ApiCore.prototype.GetClassType = function () { return ""; }; /** - * Gets a document color object by color name. - * @param {highlightColor} sColor - available highlight color - * @returns {object} + * Sets the document category. + * @memberof ApiCore + * @param {string} sCategory - The document category. + * @since 9.0.0 */ -function private_getHighlightColorByName(sColor){ return null; } +ApiCore.prototype.SetCategory = function (sCategory) {}; /** - * Gets a document highlight name by color object. - * @param {object} oColor - available highlight color - * @returns {highlightColor} + * Returns the document category. + * @memberof ApiCore + * @returns {string} - The document category. + * @since 9.0.0 */ -function private_getHighlightNameByColor(oColor){ return null; } +ApiCore.prototype.GetCategory = function () { return ""; }; + +/** + * Sets the document content status. + * @memberof ApiCore + * @param {string} sStatus - The document content status. + * @since 9.0.0 + */ +ApiCore.prototype.SetContentStatus = function (sStatus) {}; + +/** + * Returns the document content status. + * @memberof ApiCore + * @returns {string} - The document content status. + * @since 9.0.0 + */ +ApiCore.prototype.GetContentStatus = function () { return ""; }; + +/** + * Sets the document creation date. + * @memberof ApiCore + * @param {Date} oCreated - The document creation date. + * @since 9.0.0 + */ +ApiCore.prototype.SetCreated = function (oCreated) {}; + +/** + * Returns the document creation date. + * @memberof ApiCore + * @returns {Date}- The document creation date. + * @since 9.0.0 + */ +ApiCore.prototype.GetCreated = function () { return new Date(); }; + +/** + * Sets the document author. + * @memberof ApiCore + * @param {string} sCreator - The document author. + * @since 9.0.0 + */ +ApiCore.prototype.SetCreator = function (sCreator) {}; + +/** + * Returns the document author. + * @memberof ApiCore + * @returns {string} - The document author. + * @since 9.0.0 + */ +ApiCore.prototype.GetCreator = function () { return ""; }; + +/** + * Sets the document description. + * @memberof ApiCore + * @param {string} sDescription - The document description. + * @since 9.0.0 + */ +ApiCore.prototype.SetDescription = function (sDescription) {}; + +/** + * Returns the document description. + * @memberof ApiCore + * @returns {string} - The document description. + * @since 9.0.0 + */ +ApiCore.prototype.GetDescription = function () { return ""; }; + +/** + * Sets the document identifier. + * @memberof ApiCore + * @param {string} sIdentifier - The document identifier. + * @since 9.0.0 + */ +ApiCore.prototype.SetIdentifier = function (sIdentifier) {}; + +/** + * Returns the document identifier. + * @memberof ApiCore + * @returns {string} - The document identifier. + * @since 9.0.0 + */ +ApiCore.prototype.GetIdentifier = function () { return ""; }; + +/** + * Sets the document keywords. + * @memberof ApiCore + * @param {string} sKeywords - The document keywords in the string format. + * @since 9.0.0 + * + */ +ApiCore.prototype.SetKeywords = function (sKeywords) {}; + +/** + * Returns the document keywords. + * @memberof ApiCore + * @returns {string} - The document keywords in the string format. + * @since 9.0.0 + */ +ApiCore.prototype.GetKeywords = function () { return ""; }; + +/** + * Sets the document language. + * @memberof ApiCore + * @param {string} sLanguage - The document language. + * @since 9.0.0 + */ +ApiCore.prototype.SetLanguage = function (sLanguage) {}; + +/** + * Returns the document language. + * @memberof ApiCore + * @returns {string} - The document language. + * @since 9.0.0 + */ +ApiCore.prototype.GetLanguage = function () { return ""; }; + +/** + * Sets the name of the user who last modified the document. + * @memberof ApiCore + * @param {string} sLastModifiedBy - The name of the user who last modified the document. + * @since 9.0.0 + */ +ApiCore.prototype.SetLastModifiedBy = function (sLastModifiedBy) {}; + +/** + * Returns the name of the user who last modified the document. + * @memberof ApiCore + * @returns {string} - The name of the user who last modified the document. + * @since 9.0.0 + */ +ApiCore.prototype.GetLastModifiedBy = function () { return ""; }; + +/** + * Sets the date when the document was last printed. + * @memberof ApiCore + * @param {Date} oLastPrinted - The date when the document was last printed. + * @since 9.0.0 + */ +ApiCore.prototype.SetLastPrinted = function (oLastPrinted) {}; + +/** + * Returns the date when the document was last printed. + * @memberof ApiCore + * @returns {Date} - The date when the document was last printed. + * @since 9.0.0 + */ +ApiCore.prototype.GetLastPrinted = function () { return new Date(); }; + +/** + * Sets the date when the document was last modified. + * @memberof ApiCore + * @param {Date} oModified - The date when the document was last modified. + * @since 9.0.0 + */ +ApiCore.prototype.SetModified = function (oModified) {}; + +/** + * Returns the date when the document was last modified. + * @memberof ApiCore + * @returns {Date} - The date when the document was last modified. + * @since 9.0.0 + */ +ApiCore.prototype.GetModified = function () { return new Date(); }; + +/** + * Sets the document revision. + * @memberof ApiCore + * @param {string} sRevision - The document revision. + * @since 9.0.0 + */ +ApiCore.prototype.SetRevision = function (sRevision) {}; + +/** + * Returns the document revision. + * @memberof ApiCore + * @returns {string} - The document revision. + * @since 9.0.0 + */ +ApiCore.prototype.GetRevision = function () { return ""; }; + +/** + * Sets the document subject. + * @memberof ApiCore + * @param {string} sSubject - The document subject. + * @since 9.0.0 + */ +ApiCore.prototype.SetSubject = function (sSubject) {}; + +/** + * Returns the document subject. + * @memberof ApiCore + * @returns {string} - The document subject. + * @since 9.0.0 + */ +ApiCore.prototype.GetSubject = function () { return ""; }; + +/** + * Sets the document title. + * @memberof ApiCore + * @param {string} sTitle - The document title. + * @since 9.0.0 + */ +ApiCore.prototype.SetTitle = function (sTitle) {}; + +/** + * Returns the document title. + * @memberof ApiCore + * @returns {string} - The document title. + * @since 9.0.0 + */ +ApiCore.prototype.GetTitle = function () { return ""; }; + +/** + * Sets the document version. + * @memberof ApiCore + * @param {string} sVersion - The document version. + * @since 9.0.0 + */ +ApiCore.prototype.SetVersion = function (sVersion) {}; + +/** + * Returns the document version. + * @memberof ApiCore + * @returns {string} - The document version. + * @since 9.0.0 + */ +ApiCore.prototype.GetVersion = function () { return ""; }; + +/** + * Returns a type of the ApiCustomProperties class. + * @memberof ApiCustomProperties + * @returns {"customProperties"} + * @since 9.0.0 + */ +ApiCustomProperties.prototype.GetClassType = function () { return ""; }; + +/** + * Adds a custom property to the document with automatic type detection. + * @memberof ApiCustomProperties + * @param {string} name - The custom property name. + * @param {string | number | boolean | Date} value - The custom property value. + * @returns {boolean} - Returns false if the type is unsupported. + * @since 9.0.0 + */ +ApiCustomProperties.prototype.Add = function (name, value) { return true; }; + +/** + * Returns the value of a custom property by its name. + * @memberof ApiCustomProperties + * @param {string} name - The custom property name. + * @returns {string | number | Date | boolean | null} - The value of the custom property or null if the property does not exist. + * @since 9.0.0 + */ +ApiCustomProperties.prototype.Get = function (name) { return ""; }; + +/** + * @param oApiRange + * @param oTextPr + * @constructor + */ +function ApiRangeTextPr(oApiRange, oTextPr){} +ApiRangeTextPr.prototype = Object.create(ApiTextPr.prototype); +ApiRangeTextPr.prototype.constructor = ApiRangeTextPr; /** * Class representing a presentation. @@ -1879,6 +2595,12 @@ function ApiThemeFontScheme(ofontScheme){} */ function ApiSlide(oSlide){} +/** + * Class representing a notes page. + * @constructor + */ +function ApiNotesPage(oNotes) {} + /** * Class representing a group of drawings. * @constructor @@ -1891,7 +2613,7 @@ ApiGroup.prototype.constructor = ApiGroup; * Class representing a table. * @param oGraphicFrame * @constructor - * */ + */ function ApiTable(oGraphicFrame){} ApiTable.prototype = Object.create(ApiDrawing.prototype); ApiTable.prototype.constructor = ApiTable; @@ -1933,7 +2655,7 @@ function ApiTableCell(oCell){} /** * 60000th of a degree (5400000 = 90 degrees). * @typedef {number} PositiveFixedAngle - * */ + */ /** * A border type. @@ -1968,53 +2690,48 @@ function ApiTableCell(oCell){} /** * A bullet type which will be added to the paragraph in spreadsheet or presentation. * @typedef {("None" | "ArabicPeriod" | "ArabicParenR" | "RomanUcPeriod" | "RomanLcPeriod" | "AlphaLcParenR" | "AlphaLcPeriod" | "AlphaUcParenR" | "AlphaUcPeriod")} BulletType -*/ - -/** - * This type specifies the available chart types which can be used to create a new chart. - * @typedef {("bar" | "barStacked" | "barStackedPercent" | "bar3D" | "barStacked3D" | "barStackedPercent3D" | "barStackedPercent3DPerspective" | "horizontalBar" | "horizontalBarStacked" | "horizontalBarStackedPercent" | "horizontalBar3D" | "horizontalBarStacked3D" | "horizontalBarStackedPercent3D" | "lineNormal" | "lineStacked" | "lineStackedPercent" | "line3D" | "pie" | "pie3D" | "doughnut" | "scatter" | "stock" | "area" | "areaStacked" | "areaStackedPercent")} ChartType */ /** * The available text vertical alignment (used to align text in a shape with a placement for text inside it). * @typedef {("top" | "center" | "bottom")} VerticalTextAlign - * */ + */ /** * The available color scheme identifiers. * @typedef {("accent1" | "accent2" | "accent3" | "accent4" | "accent5" | "accent6" | "bg1" | "bg2" | "dk1" | "dk2" | "lt1" | "lt2" | "tx1" | "tx2")} SchemeColorId - * */ + */ /** * The available preset color names. * @typedef {("aliceBlue" | "antiqueWhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedAlmond" | "blue" | "blueViolet" | "brown" | "burlyWood" | "cadetBlue" | "chartreuse" | "chocolate" | "coral" | "cornflowerBlue" | "cornsilk" | "crimson" | "cyan" | "darkBlue" | "darkCyan" | "darkGoldenrod" | "darkGray" | "darkGreen" | "darkGrey" | "darkKhaki" | "darkMagenta" | "darkOliveGreen" | "darkOrange" | "darkOrchid" | "darkRed" | "darkSalmon" | "darkSeaGreen" | "darkSlateBlue" | "darkSlateGray" | "darkSlateGrey" | "darkTurquoise" | "darkViolet" | "deepPink" | "deepSkyBlue" | "dimGray" | "dimGrey" | "dkBlue" | "dkCyan" | "dkGoldenrod" | "dkGray" | "dkGreen" | "dkGrey" | "dkKhaki" | "dkMagenta" | "dkOliveGreen" | "dkOrange" | "dkOrchid" | "dkRed" | "dkSalmon" | "dkSeaGreen" | "dkSlateBlue" | "dkSlateGray" | "dkSlateGrey" | "dkTurquoise" | "dkViolet" | "dodgerBlue" | "firebrick" | "floralWhite" | "forestGreen" | "fuchsia" | "gainsboro" | "ghostWhite" | "gold" | "goldenrod" | "gray" | "green" | "greenYellow" | "grey" | "honeydew" | "hotPink" | "indianRed" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderBlush" | "lawnGreen" | "lemonChiffon" | "lightBlue" | "lightCoral" | "lightCyan" | "lightGoldenrodYellow" | "lightGray" | "lightGreen" | "lightGrey" | "lightPink" | "lightSalmon" | "lightSeaGreen" | "lightSkyBlue" | "lightSlateGray" | "lightSlateGrey" | "lightSteelBlue" | "lightYellow" | "lime" | "limeGreen" | "linen" | "ltBlue" | "ltCoral" | "ltCyan" | "ltGoldenrodYellow" | "ltGray" | "ltGreen" | "ltGrey" | "ltPink" | "ltSalmon" | "ltSeaGreen" | "ltSkyBlue" | "ltSlateGray" | "ltSlateGrey" | "ltSteelBlue" | "ltYellow" | "magenta" | "maroon" | "medAquamarine" | "medBlue" | "mediumAquamarine" | "mediumBlue" | "mediumOrchid" | "mediumPurple" | "mediumSeaGreen" | "mediumSlateBlue" | "mediumSpringGreen" | "mediumTurquoise" | "mediumVioletRed" | "medOrchid" | "medPurple" | "medSeaGreen" | "medSlateBlue" | "medSpringGreen" | "medTurquoise" | "medVioletRed" | "midnightBlue" | "mintCream" | "mistyRose" | "moccasin" | "navajoWhite" | "navy" | "oldLace" | "olive" | "oliveDrab" | "orange" | "orangeRed" | "orchid" | "paleGoldenrod" | "paleGreen" | "paleTurquoise" | "paleVioletRed" | "papayaWhip" | "peachPuff" | "peru" | "pink" | "plum" | "powderBlue" | "purple" | "red" | "rosyBrown" | "royalBlue" | "saddleBrown" | "salmon" | "sandyBrown" | "seaGreen" | "seaShell" | "sienna" | "silver" | "skyBlue" | "slateBlue" | "slateGray" | "slateGrey" | "snow" | "springGreen" | "steelBlue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whiteSmoke" | "yellow" | "yellowGreen")} PresetColor - * */ + */ /** * Possible values for the position of chart tick labels (either horizontal or vertical). - * * "none" - not display the selected tick labels. - * * "nextTo" - set the position of the selected tick labels next to the main label. - * * "low" - set the position of the selected tick labels in the part of the chart with lower values. - * * "high" - set the position of the selected tick labels in the part of the chart with higher values. + * "none" - not display the selected tick labels. + * "nextTo" - set the position of the selected tick labels next to the main label. + * "low" - set the position of the selected tick labels in the part of the chart with lower values. + * "high" - set the position of the selected tick labels in the part of the chart with higher values. * @typedef {("none" | "nextTo" | "low" | "high")} TickLabelPosition - * **/ + */ /** * The type of a fill which uses an image as a background. - * * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. - * * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. + * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. + * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. * @typedef {"tile" | "stretch"} BlipFillType - * */ + */ /** * The available preset patterns which can be used for the fill. * @typedef {"cross" | "dashDnDiag" | "dashHorz" | "dashUpDiag" | "dashVert" | "diagBrick" | "diagCross" | "divot" | "dkDnDiag" | "dkHorz" | "dkUpDiag" | "dkVert" | "dnDiag" | "dotDmnd" | "dotGrid" | "horz" | "horzBrick" | "lgCheck" | "lgConfetti" | "lgGrid" | "ltDnDiag" | "ltHorz" | "ltUpDiag" | "ltVert" | "narHorz" | "narVert" | "openDmnd" | "pct10" | "pct20" | "pct25" | "pct30" | "pct40" | "pct5" | "pct50" | "pct60" | "pct70" | "pct75" | "pct80" | "pct90" | "plaid" | "shingle" | "smCheck" | "smConfetti" | "smGrid" | "solidDmnd" | "sphere" | "trellis" | "upDiag" | "vert" | "wave" | "wdDnDiag" | "wdUpDiag" | "weave" | "zigZag"} PatternType - * */ + */ /** * The available types of tick mark appearance. * @typedef {("cross" | "in" | "none" | "out")} TickMark - * */ + */ /** * Text transform type. @@ -2024,7 +2741,7 @@ function ApiTableCell(oCell){} * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform - * */ + */ /** * Axis position in the chart. @@ -2035,214 +2752,56 @@ function ApiTableCell(oCell){} * Standard numeric format. * @typedef {("General" | "0" | "0.00" | "#,##0" | "#,##0.00" | "0%" | "0.00%" | * "0.00E+00" | "# ?/?" | "# ??/??" | "m/d/yyyy" | "d-mmm-yy" | "d-mmm" | "mmm-yy" | "h:mm AM/PM" | - * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_);(#,##0)" | "#,##0_);[Red](#,##0)" | - * "#,##0.00_);(#,##0.00)" | "#,##0.00_);[Red](#,##0.00)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_\);(#,##0)" | "#,##0_\);\[Red\]\(#,##0)" | + * "#,##0.00_\);\(#,##0.00\)" | "#,##0.00_\);\[Red\]\(#,##0.00\)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + */ + +/** + * @typedef {("body" | "chart" | "clipArt" | "ctrTitle" | "diagram" | "date" | "footer" | "header" | "media" | "object" | "picture" | "sldImage" | "sldNumber" | "subTitle" | "table" | "title")} PlaceholderType - Available placeholder types. + */ + +/** + * Any valid drawing element. + * @typedef {(ApiShape | ApiImage | ApiGroup | ApiOleObject | ApiTable | ApiChart )} Drawing + */ + +/** + * Available drawing element for grouping. + * @typedef {(ApiShape | ApiGroup | ApiImage | ApiChart)} DrawingForGroup + */ + +/** + * Any valid element which can be added to the document structure. + * @typedef {(ApiParagraph)} DocumentElement + */ + +/** + * The types of elements that can be added to the paragraph structure. + * @typedef {(ApiUnsupported | ApiRun | ApiHyperlink)} ParagraphContent */ /** * The 1000th of a percent (100000 = 100%). * @typedef {number} PositivePercentage - * */ - -/** - * Creates a group of drawings. - * @memberof ApiInterface - * @param {Array} aDrawings - The array of drawings. - * @returns {ApiGroup} - * */ -ApiInterface.prototype.CreateGroup = function(aDrawings){ return new ApiGroup(); }; - -/** - * Creates a table. - * @param nCols - Number of columns. - * @param nRows - Number of rows. - * @returns {ApiTable} */ -ApiInterface.prototype.CreateTable = function(nCols, nRows){ return new ApiTable(); }; /** - * Returns a slide by its position in the presentation. - * @memberof ApiPresentation - * @param {number} nIndex - The slide number (position) in the presentation. - * @returns {ApiSlide} - */ -ApiPresentation.prototype.GetSlideByIndex = function(nIndex){ return new ApiSlide(); }; - -/** - * Returns the type of the ApiTable object. - * @returns {"table"} - * */ -ApiTable.prototype.GetClassType = function(){ return ""; }; - -/** - * Returns a row by its index. - * @param nIndex {number} - The row index (position) in the table. - * @returns {ApiTableRow} - * */ -ApiTable.prototype.GetRow = function(nIndex){ return new ApiTableRow(); }; - -/** - * Merges an array of cells. If merge is successful, it will return merged cell, otherwise "null". - * Warning: The number of cells in any row and the number of rows in the current table may be changed. - * @param {ApiTableCell[]} aCells - The array of cells. - * @returns {ApiTableCell} - */ -ApiTable.prototype.MergeCells = function(aCells){ return new ApiTableCell(); }; - -/** - * Specifies the components of the conditional formatting of the referenced table style (if one exists) - * which shall be applied to the set of table rows with the current table-level property exceptions. A table style - * can specify up to six different optional conditional formats [Example: Different formatting for first column], - * which then can be applied or omitted from individual table rows in the parent table. + * Represents the type of objects in a selection. + * @typedef {("none" | "shapes" | "slides" | "text")} SelectionType - Available selection types. * - * The default setting is to apply the row and column banding formatting, but not the first row, last row, first - * column, or last column formatting. - * @param {boolean} isFirstColumn - Specifies that the first column conditional formatting shall be applied to the - * table. - * @param {boolean} isFirstRow - Specifies that the first row conditional formatting shall be applied to the table. - * @param {boolean} isLastColumn - Specifies that the last column conditional formatting shall be applied to the - * table. - * @param {boolean} isLastRow - Specifies that the last row conditional formatting shall be applied to the table. - * @param {boolean} isHorBand - Specifies that the horizontal banding conditional formatting shall not be applied - * to the table. - * @param {boolean} isVerBand - Specifies that the vertical banding conditional formatting shall not be applied to - * the table. */ -ApiTable.prototype.SetTableLook = function(isFirstColumn, isFirstRow, isLastColumn, isLastRow, isHorBand, isVerBand){}; /** - * Adds a new row to the current table. - * @param {ApiTableCell} [oCell] - If not specified, a new row will be added to the end of the table. - * @param {boolean} [isBefore=false] - Adds a new row before or after the specified cell. If no cell is specified, - * then this parameter will be ignored. - * @returns {ApiTableRow} + * Private method to collect all objects of a specific type from the presentation (OleObjects, Charts, Shapes, Images). + * Calls 'getObjectsMethod' method on each slide, master and layout to get the objects. */ -ApiTable.prototype.AddRow = function(oCell, isBefore){ return new ApiTableRow(); }; +ApiPresentation.prototype._collectAllObjects = function (getObjectsMethod) {}; /** - * Adds a new column to the end of the current table. - * @param {ApiTableCell} [oCell] - If not specified, a new column will be added to the end of the table. - * @param {boolean} [isBefore=false] - Add a new column before or after the specified cell. If no cell is specified, - * then this parameter will be ignored. + * Class representing the selection in the presentation. + * @constructor */ -ApiTable.prototype.AddColumn = function(oCell, isBefore){}; - -/** - * Removes a table row with the specified cell. - * @param {ApiTableCell} oCell - The table cell from the row which will be removed. - * @returns {boolean} - defines if the table is empty after removing or not. - */ -ApiTable.prototype.RemoveRow = function(oCell){ return true; }; - -/** - * Removes a table column with the specified cell. - * @param {ApiTableCell} oCell - The table cell from the column which will be removed. - * @returns {boolean} - defines if the table is empty after removing or not. - */ -ApiTable.prototype.RemoveColumn = function(oCell){ return true; }; - -/** - * Returns the type of the ApiTableRow class. - * @returns {"tableRow"} - */ -ApiTableRow.prototype.GetClassType = function(){ return ""; }; - -/** - * Returns a number of cells in the current row. - * @returns {number} - */ -ApiTableRow.prototype.GetCellsCount = function(){ return 0; }; - -/** - * Returns a cell by its position in the current row. - * @param {number} nPos - The cell position in the table row. - * @returns {ApiTableCell} - */ -ApiTableRow.prototype.GetCell = function(nPos){ return new ApiTableCell(); }; - -/** - * Sets the height to the current table row. - * @param {EMU} [nValue] - The row height in English measure units. - */ -ApiTableRow.prototype.SetHeight = function(nValue){}; - -/** - * Returns the type of the ApiTableCell class. - * @returns {"tableCell"} - */ -ApiTableCell.prototype.GetClassType = function(){ return ""; }; - -/** - * Returns the current cell content. - * @returns {ApiDocumentContent} - */ -ApiTableCell.prototype.GetContent = function(){ return new ApiDocumentContent(); }; - -/** - * Specifies an amount of space which shall be left between the bottom extent of the cell contents and the border - * of a specific individual table cell within a table. - * @param {?twips} nValue - If this value is null, then default table cell bottom margin shall be used, - * otherwise override the table cell bottom margin with specified value for the current cell. - */ -ApiTableCell.prototype.SetCellMarginBottom = function(nValue){}; - -/** - * Specifies an amount of space which shall be left between the left extent of the current cell contents and the - * left edge border of a specific individual table cell within a table. - * @param {?twips} nValue - If this value is null, then default table cell left margin shall be used, - * otherwise override the table cell left margin with specified value for the current cell. - */ -ApiTableCell.prototype.SetCellMarginLeft = function(nValue){}; - -/** - * Specifies an amount of space which shall be left between the right extent of the current cell contents and the - * right edge border of a specific individual table cell within a table. - * @param {?twips} nValue - If this value is null, then default table cell right margin shall be used, - * otherwise override the table cell right margin with specified value for the current cell. - */ -ApiTableCell.prototype.SetCellMarginRight = function(nValue){}; - -/** - * Specifies an amount of space which shall be left between the top extent of the current cell contents and the - * top edge border of a specific individual table cell within a table. - * @param {?twips} nValue - If this value is null, then default table cell top margin shall be used, - * otherwise override the table cell top margin with specified value for the current cell. - */ -ApiTableCell.prototype.SetCellMarginTop = function(nValue){}; - -/** - * Sets the border which shall be displayed at the bottom of the current table cell. - * @param {mm} fSize - The width of the current border. - * @param {ApiFill} oApiFill - The color or pattern used to fill the current border. - */ -ApiTableCell.prototype.SetCellBorderBottom = function(fSize, oApiFill){}; - -/** - * Sets the border which shall be displayed at the left of the current table cell. - * @param {mm} fSize - The width of the current border. - * @param {ApiFill} oApiFill - The color or pattern used to fill the current border. - */ -ApiTableCell.prototype.SetCellBorderLeft = function(fSize, oApiFill){}; - -/** - * Sets the border which shall be displayed at the right of the current table cell. - * @param {mm} fSize - The width of the current border. - * @param {ApiFill} oApiFill - The color or pattern used to fill the current border. - */ -ApiTableCell.prototype.SetCellBorderRight = function(fSize, oApiFill){}; - -/** - * Sets the border which shall be displayed at the top of the current table cell. - * @param {mm} fSize - The width of the current border. - * @param {ApiFill} oApiFill - The color or pattern used to fill the current border. - */ -ApiTableCell.prototype.SetCellBorderTop = function(fSize, oApiFill){}; - -/** - * Specifies the vertical alignment for text within the current table cell. - * @param {("top" | "center" | "bottom")} sType - The type of the vertical alignment. - */ -ApiTableCell.prototype.SetVerticalAlign = function(sType){}; +function ApiSelection() {} /** * The callback function which is called when the specified range of the current sheet changes. @@ -2271,10 +2830,11 @@ ApiTableCell.prototype.SetVerticalAlign = function(sType){}; * @property {PageOrientation} PageOrientation - Returns or sets the page orientation. * @property {boolean} PrintHeadings - Returns or sets the page PrintHeadings property. * @property {boolean} PrintGridlines - Returns or sets the page PrintGridlines property. - * @property {Array} Defnames - Returns an array of the ApiName objects. - * @property {Array} Comments - Returns all comments from the current worksheet. + * @property {ApiName[]} Defnames - Returns an array of the ApiName objects. + * @property {ApiComment[]} Comments - Returns all comments from the current worksheet. * @property {ApiFreezePanes} FreezePanes - Returns the freeze panes for the current worksheet. * @property {ApiProtectedRange[]} AllProtectedRanges - Returns all protected ranges from the current worksheet. + * @property {ApiPivotTable[]} PivotTables - Returns all pivot tables from the current worksheet. */ function ApiWorksheet(worksheet) {} @@ -2316,6 +2876,7 @@ function ApiWorksheet(worksheet) {} * @property {'xlDownward' | 'xlHorizontal' | 'xlUpward' | 'xlVertical'} Orientation - Sets an angle to the current cell range. * @property {ApiAreas} Areas - Returns a collection of the areas. * @property {ApiCharacters} Characters - Returns the ApiCharacters object that represents a range of characters within the object text. Use the ApiCharacters object to format characters within a text string. + * @property {ApiPivotTable | null} PivotTable - Returns the ApiPivotTable object that represents the pivot table report containing the upper-left corner of the specified range. */ function ApiRange(range, areas) {} @@ -2341,14 +2902,6 @@ function ApiImage(oImage) {} ApiImage.prototype = Object.create(ApiDrawing.prototype); ApiImage.prototype.constructor = ApiImage; -/** - * Class representing a chart. - * @constructor - */ -function ApiChart(oChart) {} -ApiChart.prototype = Object.create(ApiDrawing.prototype); -ApiChart.prototype.constructor = ApiChart; - /** * Class representing an OLE object. * @constructor @@ -2386,26 +2939,26 @@ ApiOleObject.prototype.constructor = ApiOleObject; * "slateBlue" | "slateGray" | "slateGrey" | "snow" | "springGreen" | "steelBlue" | "tan" | "teal" | * "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whiteSmoke" | "yellow" | * "yellowGreen")} PresetColor - * */ + */ /** * Possible values for the position of chart tick labels (either horizontal or vertical). - * * "none" - does not display the selected tick labels. - * * "nextTo" - sets the position of the selected tick labels next to the main label. - * * "low" - sets the position of the selected tick labels in the part of the chart with lower values. - * * "high" - sets the position of the selected tick labels in the part of the chart with higher values. + * "none" - does not display the selected tick labels. + * "nextTo" - sets the position of the selected tick labels next to the main label. + * "low" - sets the position of the selected tick labels in the part of the chart with lower values. + * "high" - sets the position of the selected tick labels in the part of the chart with higher values. * @typedef {("none" | "nextTo" | "low" | "high")} TickLabelPosition - * **/ + */ /** * The page orientation type. * @typedef {("xlLandscape" | "xlPortrait")} PageOrientation - * */ + */ /** * The type of tick mark appearance. * @typedef {("cross" | "in" | "none" | "out")} TickMark - * */ + */ /** * Text transform type. @@ -2415,7 +2968,7 @@ ApiOleObject.prototype.constructor = ApiOleObject; * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform - * */ + */ /** * Axis position in the chart. @@ -2426,28 +2979,65 @@ ApiOleObject.prototype.constructor = ApiOleObject; * Standard numeric format. * @typedef {("General" | "0" | "0.00" | "#,##0" | "#,##0.00" | "0%" | "0.00%" | * "0.00E+00" | "# ?/?" | "# ??/??" | "m/d/yyyy" | "d-mmm-yy" | "d-mmm" | "mmm-yy" | "h:mm AM/PM" | - * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_);(#,##0)" | "#,##0_);[Red](#,##0)" | - * "#,##0.00_);(#,##0.00)" | "#,##0.00_);[Red](#,##0.00)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_\);(#,##0)" | "#,##0_\);\[Red\]\(#,##0)" | + * "#,##0.00_\);\(#,##0.00\)" | "#,##0.00_\);\[Red\]\(#,##0.00\)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat */ /** - * The cell references type. + * The cell reference type. * @typedef {('xlA1' | 'xlR1C1')} ReferenceStyle - * */ + */ /** * Specifies the part of the range to be pasted. - * @typedef {("xlPasteAll" | "xlPasteAllExceptBorders" | - * | "xlPasteColumnWidths" | "xlPasteComments" + * @typedef {("xlPasteAll" | "xlPasteAllExceptBorders" + * | "xlPasteColumnWidths" | "xlPasteComments" * | "xlPasteFormats" | "xlPasteFormulas" | "xlPasteFormulasAndNumberFormats" * | "xlPasteValues" | "xlPasteValuesAndNumberFormats" )} PasteType - * */ + */ /** - * Specifies how numeric data will be calculated with the destinations cells on the worksheet. + * The mathematical operation which will be applied to the copied data. * @typedef {("xlPasteSpecialOperationAdd" | "xlPasteSpecialOperationDivide" | "xlPasteSpecialOperationMultiply"| * "xlPasteSpecialOperationNone" | "xlPasteSpecialOperationSubtract" )} PasteSpecialOperation - * */ + */ + +/** +* Specifies how to shift cells to replace deleted cells. +* @typedef {("up" | "left")} DeleteShiftDirection +*/ + +/** + * Any valid drawing element. + * @typedef {(ApiShape | ApiImage | ApiOleObject | ApiChart )} Drawing + */ + +/** + * The report filter area settings. + * @typedef {object} PivotTableFilterAreaInfo + * @property {FieldsInReportFilterType} Type - Specifies how the report filter fields are located. + * @property {number} ReportFilterFields - Defines the number of the report filter fields. + */ + +/** + * The settings for adding row, column, and page fields to the pivot table report. + * @typedef {object} PivotTableFieldOptions + * @property {number | string | number[] | string[]} [rows] - An array of field names or IDs to be added as rows or added to the category axis. + * @property {number | string | number[] | string[]} [columns] - An array of field names or IDs to be added as columns or added to the series axis. + * @property {number | string | number[] | string[]} [pages] - An array of field names or IDs to be added as pages or added to the page area. + * @property {boolean} [addToTable=false] - Specifies whether to apply fields only to the pivot table reports. If `true`, the specified fields will be added to the report + * without replacing existing fields. If `false`, existing fields will be replaced with the new fields. + */ + +/** + * Any valid element which can be added to the document structure. + * @typedef {(ApiParagraph)} DocumentElement + */ + +/** + * The types of elements that can be added to the paragraph structure. + * @typedef {(ApiUnsupported | ApiRun | ApiHyperlink)} ParagraphContent + */ /** * Class representing a base class for the color types. @@ -2455,6 +3045,13 @@ ApiOleObject.prototype.constructor = ApiOleObject; */ function ApiColor(color) {} +/** + * Returns a color value in RGB format. + * @memberof ApiColor + * @returns {number} + */ +ApiColor.prototype.GetRGB = function () { return 0; }; + /** * Class representing a name. * @constructor @@ -2498,6 +3095,125 @@ function ApiCommentReply(oParentComm, oCommentReply) {} */ function ApiAreas(items, parent) {} +/** + * Class representing a pivot table. + * @constructor + * @property {string} Name - Returns or sets a name of the pivot table. + * @property {boolean} ColumnGrand - Returns or sets the Grand Totals setting for the pivot table columns. + * @property {boolean} RowGrand - Returns or sets the Grand Totals setting for the pivot table rows. + * @property {boolean} DisplayFieldCaptions - Returns or sets the setting which specifies whether to display field headers for rows and columns. + * @property {string} Title - Returns or sets the pivot table title. + * @property {string} Description - Returns or sets the pivot table description. + * @property {string} StyleName - Returns or sets the pivot table style name. + * @property {ApiWorksheet} Parent - Returns the parent object for the current pivot table. + * @property {boolean} ShowTableStyleRowHeaders - Returns or sets the setting which specifies whether the row headers of the pivot table will be highlighted with the special formatting. + * @property {boolean} ShowTableStyleColumnHeaders - Returns or sets the setting which specifies whether the column headers of the pivot table will be highlighted with the special formatting. + * @property {boolean} ShowTableStyleRowStripes - Returns or sets the setting which specifies whether the background color alternation for odd and even rows will be enabled for the pivot table. + * @property {boolean} ShowTableStyleColumnStripes - Returns or sets the setting which specifies whether the background color alternation for odd and even columns will be enabled for the pivot table. + * @property {ApiRange} Source - Returns or sets the source range for the pivot table. + * @property {ApiRange | null} ColumnRange - Returns a Range object that represents the column area in the pivot table report. + * @property {ApiRange | null} RowRange - Returns a Range object that represents the row area in the pivot table report. + * @property {ApiRange} DataBodyRange - Returns a Range object that represents the range of values in the pivot table. + * @property {ApiRange | null} TableRange1 - Returns a Range object that represents the entire pivot table report, but doesn't include page fields. + * @property {ApiRange | null} TableRange2 - Returns a Range object that represents the entire pivot table report, including page fields. + * @property {string} GrandTotalName - Returns or sets the text string label that is displayed in the grand total column or row heading in the specified pivot table report. + * @property {boolean} RepeatAllLabels - Specifies whether to repeat item labels for all pivot fields in the specified pivot table. + * @property {object} RowAxisLayout - Sets the way the specified pivot table items appear — in table format or in outline format. + * @property {boolean} LayoutBlankLine - Sets the setting which specifies whether to insert blank rows after each item in the pivot table. + * @property {boolean} LayoutSubtotals - Sets the setting which specifies whether to show subtotals in the pivot table. + * @property {number} SubtotalLocation - Sets the layout subtotal location. + * @property {ApiPivotField[]} PivotFields - Returns all pivot fields in the pivot table. + * @property {ApiPivotField[]} ColumnFields - Returns an array that is currently displayed as column fields in the pivot table. + * @property {ApiPivotField[]} DataFields - Returns an array that is currently displayed as data fields in the pivot table. + * @property {ApiPivotField[]} HiddenFields - Returns an array that represents all hidden fields in the pivot table. + * @property {ApiPivotField[]} VisibleFields - Returns an array that represents all visible fields in the pivot table. + * @property {ApiPivotField[]} PageFields - Returns an array that is currently displayed as page fields in the pivot table. + * @property {ApiPivotField[]} RowFields - Returns an array that is currently displayed as row fields in the pivot table. + */ +function ApiPivotTable(pivot, api) {} + +/** @type {CT_pivotTableDefinition} */ + +/** + * Class representing a pivot table field. + * @constructor + * @property {number} Position - Returns or sets a value that represents the position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data). + * @property {number} Orientation - Returns or sets a pivot field orientation value that represents the location of the field in the specified pivot table report. + * @property {string} Caption - Returns or sets a value that represents the label text for the pivot field. + * @property {string} Name - Returns or sets a value representing the object name. + * @property {string} Value - Returns or sets a value representing the name of the specified field in the pivot table report. + * @property {string} SourceName - Returns a source name for the pivot table field. + * @property {number} Index - Returns an index for the pivot table field. + * @property {ApiPivotTable} Table - Returns the ApiPivotTable object which represents the pivot table for the current field. + * @property {ApiPivotTable} Parent - Returns the parent object for the current field. + * @property {boolean} LayoutCompactRow - Returns or sets the setting which specifies whether a pivot table field is compacted. + * @property {number} LayoutForm - Returns or sets the way the specified pivot table items appear — in table format or in outline format. + * @property {boolean} LayoutPageBreak - Returns or sets the setting which specifies whether to insert a page break after each field. + * @property {boolean} ShowingInAxis - Returns the setting which specifies whether the pivot table field is currently visible in the pivot table. + * @property {boolean} RepeatLabels - Returns or sets the setting which specifies whether to repeat items labels at each row. + * @property {boolean} LayoutBlankLine - Returns and sets the setting which specifies whether to insert blank rows after each item. + * @property {boolean} ShowAllItems - Returns or sets the setting which specifies whether to show items with no data. + * @property {boolean} LayoutSubtotals - Returns or sets the setting which specifies whether to show subtotals. + * @property {number} LayoutSubtotalLocation - Returns or sets the layout subtotal location. + * @property {string} SubtotalName - Returns or sets the text label displayed in the subtotal column or row heading in the specified pivot table report. + * @property {object} Subtotals - Returns or sets the subtotals. + * @property {number} Formula - Returns or sets a value that represents the object's formula. + * @property {boolean} DragToColumn - Returns or sets the setting which specifies whether the specified field can be dragged to the column position. + * @property {boolean} DragToRow - Returns or sets the setting which specifies whether the specified field can be dragged to the row position. + * @property {boolean} DragToData - Returns or sets the setting which specifies whether the specified field can be dragged to the data position. + * @property {boolean} DragToPage - Returns or sets the setting which specifies whether the specified field can be dragged to the page position. + * @property {string | null} NumberFormat - Returns or sets a value that represents the format code for the object. + * @property {string | number} CurrentPage - Returns the current page which is displayed for the page field (valid only for page fields). + * @property {ApiPivotItem | ApiPivotItem[]} PivotItems - Returns an object that represents either a single pivot table item (the ApiPivotItem object) + * or a collection of all the visible and hidden items (an array of the ApiPivotItem objects) in the specified field. + */ +function ApiPivotField(table, index, pivotField) {} + +/** @type {ApiPivotTable} */ + +/** @type {number} */ + +/** @type {CT_PivotField} */ + +/** + * Class representing a pivot table data field. + * @constructor + * @extends ApiPivotField + * @property {DataConsolidateFunctionType} Function - Returns or sets a function for the data field. + * @property {number} Position - Returns or sets a value that represents the data field position within a category. + * @property {PivotFieldOrientationType} Orientation - Returns a data field orientation value + * that represents the data field location in the specified pivot table report. + * @property {string} Name - Returns or sets a value representing the object name. + * @property {string} Value - Returns or sets a value representing the name of the specified data field in the pivot table report. + * @property {string} Caption - Returns or sets a value that represents the label text for the data field. + * @property {string | null} NumberFormat - Returns or sets a value that represents the format code for the object. + * @property {number} Index - Returns an index of the data field. + * @property {ApiPivotField} PivotField - Returns the pivot field from which the data field was created. + */ +function ApiPivotDataField(table, dataIndex, dataField) {} + +/** @type {number} */ + +/** @type {CT_DataField} */ +ApiPivotDataField.prototype = Object.create(ApiPivotField.prototype); +ApiPivotDataField.prototype.constructor = ApiPivotDataField;{}; +ApiPivotDataField.prototype.constructor = ApiPivotDataField; + +/** + * Class representing a pivot table field item. + * @constructor + * @property {string} Name - Returns a name of the pivot item. + * @property {string} Caption - Returns a caption of the pivot item. + * @property {string} Value - Returns a name of the specified item in the pivot table field. + * @property {string} Parent - Returns a parent of the pivot item. + * @property {string} Field - Returns a field of the pivot item. + */ +function ApiPivotItem(field, item) {} + +/** @type{ApiPivotField} */ + +/** @type{CT_Item} */ + /** * Class representing characters in an object that contains text. * @constructor @@ -2543,32 +3259,43 @@ ApiInterface.prototype.Format = function (expression, format) { return ""; }; /** * Creates a new custom function. * The description of the function parameters and result is specified using JSDoc. The @customfunction tag is required in JSDoc. - * Parameters and results can be specified as the number / string / bool / any / number[][] / string[][] / bool[][] / any[][] types. + * Parameters and results can be specified as the number / string / boolean / any / number[][] / string[][] / boolean[][] / any[][] types. * Parameters can be required or optional. A user can also set a default value. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {Function} fCustom - A new function for calculating. - * @example - * function add(first, second) { - * return first + second; - * }; - * Api.AddCustomFunction(add); */ ApiInterface.prototype.AddCustomFunction = function (fCustom) {}; /** - * Remove a custom function. + * Registers a new custom functions library (see the SetCustomFunctions plugin method). + * The description of the function parameters and result is specified using JSDoc. The @customfunction tag is required in JSDoc. + * Parameters and results can be specified as the number / string / boolean / any / number[][] / string[][] / boolean[][] / any[][] types. + * Parameters can be required or optional. A user can also set a default value. + * @memberof ApiInterface + * @param {string} sName - The library name. + * @param {Function} Func - The custom functions library code. + * @since 8.2.0 + */ +ApiInterface.prototype.AddCustomFunctionLibrary = function(sName, Func) {}; + +/** + * Removes a custom function. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} sName - The name of a custom function. * @returns {boolean} - returns false if such a function does not exist. */ ApiInterface.prototype.RemoveCustomFunction = function (sName) { return true; }; +/** + * Clears all custom functions. + * @memberof ApiInterface + * @returns {boolean} - returns false if such functions do not exist. + */ +ApiInterface.prototype.ClearCustomFunctions = function () { return true; }; + /** * Creates a new worksheet. The new worksheet becomes the active sheet. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} sName - The name of a new worksheet. */ ApiInterface.prototype.AddSheet = function (sName) {}; @@ -2576,7 +3303,6 @@ ApiInterface.prototype.AddSheet = function (sName) {}; /** * Returns a sheet collection that represents all the sheets in the active workbook. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiWorksheet[]} */ ApiInterface.prototype.GetSheets = function () { return [new ApiWorksheet()]; }; @@ -2584,7 +3310,6 @@ ApiInterface.prototype.GetSheets = function () { return [new ApiWorksheet()]; }; /** * Returns a sheet collection that represents all the sheets in the active workbook. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiWorksheet[]} */ ApiInterface.prototype.Sheets = ApiInterface.prototype.GetSheets (); @@ -2592,7 +3317,6 @@ ApiInterface.prototype.Sheets = ApiInterface.prototype.GetSheets (); /** * Sets a locale to the document. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {number} LCID - The locale specified. */ ApiInterface.prototype.SetLocale = function (LCID) {}; @@ -2600,7 +3324,6 @@ ApiInterface.prototype.SetLocale = function (LCID) {}; /** * Returns the current locale ID. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {number} */ ApiInterface.prototype.GetLocale = function () { return 0; }; @@ -2608,7 +3331,6 @@ ApiInterface.prototype.GetLocale = function () { return 0; }; /** * Returns an object that represents the active sheet. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiWorksheet} */ ApiInterface.prototype.GetActiveSheet = function () { return new ApiWorksheet(); }; @@ -2616,7 +3338,6 @@ ApiInterface.prototype.GetActiveSheet = function () { return new ApiWorksheet(); /** * Returns an object that represents the active sheet. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiWorksheet} */ ApiInterface.prototype.ActiveSheet = ApiInterface.prototype.GetActiveSheet (); @@ -2624,7 +3345,6 @@ ApiInterface.prototype.ActiveSheet = ApiInterface.prototype.GetActiveSheet (); /** * Returns an object that represents a sheet. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string | number} nameOrIndex - Sheet name or sheet index. * @returns {ApiWorksheet | null} */ @@ -2633,7 +3353,6 @@ ApiInterface.prototype.GetSheet = function (nameOrIndex) { return new ApiWorkshe /** * Returns a list of all the available theme colors for the spreadsheet. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {string[]} */ ApiInterface.prototype.GetThemesColors = function () { return [""]; }; @@ -2641,7 +3360,6 @@ ApiInterface.prototype.GetThemesColors = function () { return [""]; }; /** * Sets the theme colors to the current spreadsheet. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} sTheme - The color scheme that will be set to the current spreadsheet. * @returns {boolean} - returns false if sTheme isn't a string. */ @@ -2650,14 +3368,12 @@ ApiInterface.prototype.SetThemeColors = function (sTheme) { return true; }; /** * Creates a new history point. * @memberof ApiInterface - * @typeofeditors ["CSE"] */ ApiInterface.prototype.CreateNewHistoryPoint = function () {}; /** * Creates an RGB color setting the appropriate values for the red, green and blue color components. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -2668,7 +3384,6 @@ ApiInterface.prototype.CreateColorFromRGB = function (r, g, b) { return new ApiC /** * Creates a color selecting it from one of the available color presets. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {PresetColor} sPresetColor - A preset selected from the list of the available color preset names. * @returns {ApiColor} */ @@ -2677,7 +3392,6 @@ ApiInterface.prototype.CreateColorByName = function (sPresetColor) { return new /** * Returns the ApiRange object that represents the rectangular intersection of two or more ranges. If one or more ranges from a different worksheet are specified, an error will be returned. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {ApiRange} Range1 - One of the intersecting ranges. At least two Range objects must be specified. * @param {ApiRange} Range2 - One of the intersecting ranges. At least two Range objects must be specified. * @returns {ApiRange | null} @@ -2687,7 +3401,6 @@ ApiInterface.prototype.Intersect = function (Range1, Range2) { return new ApiRan /** * Returns an object that represents the selected range. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiInterface.prototype.GetSelection = function () { return new ApiRange(); }; @@ -2695,7 +3408,6 @@ ApiInterface.prototype.GetSelection = function () { return new ApiRange(); }; /** * Returns an object that represents the selected range. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiInterface.prototype.Selection = ApiInterface.prototype.GetSelection (); @@ -2703,7 +3415,6 @@ ApiInterface.prototype.Selection = ApiInterface.prototype.GetSelection (); /** * Adds a new name to a range of cells. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} sName - The range name. * @param {string} sRef - The reference to the specified range. It must contain the sheet name, followed by sign ! and a range of cells. * Example: "Sheet1!$A$1:$B$2". @@ -2715,7 +3426,6 @@ ApiInterface.prototype.AddDefName = function (sName, sRef, isHidden) { return tr /** * Returns the ApiName object by the range name. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} defName - The range name. * @returns {ApiName} */ @@ -2724,14 +3434,12 @@ ApiInterface.prototype.GetDefName = function (defName) { return new ApiName(); } /** * Saves changes to the specified document. * @memberof ApiInterface - * @typeofeditors ["CSE"] */ ApiInterface.prototype.Save = function () {}; /** * Returns the ApiRange object by the range reference. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} sRange - The range of cells from the current sheet. * @returns {ApiRange} */ @@ -2740,7 +3448,6 @@ ApiInterface.prototype.GetRange = function (sRange) { return new ApiRange(); }; /** * Returns the ApiWorksheetFunction object. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiWorksheetFunction} */ ApiInterface.prototype.GetWorksheetFunction = function () { return new ApiWorksheetFunction(); }; @@ -2748,557 +3455,531 @@ ApiInterface.prototype.GetWorksheetFunction = function () { return new ApiWorksh /** * Returns the ApiWorksheetFunction object. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiWorksheetFunction} */ ApiInterface.prototype.WorksheetFunction = ApiInterface.prototype.GetWorksheetFunction (); /** - * Returns the result of calculating the function. - * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * Class representing a worksheet function. + * @constructor */ -ApiWorksheetFunction.prototype.ASC = function (arg1) { return 0; }; +function ApiWorksheetFunction(api) {} + +// + "\t * @returns {number | string | boolean}\n" + "\t */ +\n" + "\tApiWorksheetFunction.prototype." + i.replaceAll(".","_") + "= function (" + test2 + ") \n" + "\t\treturn this.private_calculateFunction(\"" + i + "\", arguments);\n" + "\t;"{ return 0; }; /** - * Returns the result of calculating the function. + * For double-byte character set (DBCS) languages, the function changes full-width (double-byte) characters to half-width (single-byte) characters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text or a reference to a cell containing the text to change. + * @returns {string} */ -ApiWorksheetFunction.prototype.CHAR = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ASC = function (arg1) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the character specified by the code number from your computer's character set. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A number between 1 and 255 specifying a character from the computer character set. + * @returns {string} */ -ApiWorksheetFunction.prototype.CLEAN = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.CHAR = function (arg1) { return ""; }; /** - * Returns the result of calculating the function. + * Removes all the nonprintable characters from the text. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - A string from which nonprintable characters will be removed. + * @returns {string} + */ +ApiWorksheetFunction.prototype.CLEAN = function (arg1) { return ""; }; + +/** + * Returns the code number from your computer's character set for the first character in the specified text string. + * @memberof ApiWorksheetFunction + * @param {ApiRange | ApiName | string} arg1 - The text for which to get the code of the first character. + * @returns {number} */ ApiWorksheetFunction.prototype.CODE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Combines multiple text strings into one text string. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg_n - Up to 255 data values that will be combined. + * @returns {string} */ -ApiWorksheetFunction.prototype.CONCATENATE = function () { return 0; }; +ApiWorksheetFunction.prototype.CONCATENATE = function () { return ""; }; /** - * Returns the result of calculating the function. + * Converts a number to text, using a currency format $#.##. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string} arg1 - A number, a reference to a cell containing a number, or a formula that returns a number. + * @param {ApiRange | ApiName | number} [arg2] - A number of digits to the right of the decimal point. The number is rounded as necessary. + * If it is omitted, the function will assume it to be 2. + * @returns {string} */ -ApiWorksheetFunction.prototype.DOLLAR = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.DOLLAR = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Checks whether two text strings are exactly the same, and returns true or false. This function is case-sensitive. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {string} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The first text string. + * @param {ApiRange | ApiName | string} arg2 - The second text string. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.EXACT = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.EXACT = function (arg1, arg2) { return true; }; /** - * Returns the result of calculating the function. + * Returns the starting position of one text string within another text string. This function is case-sensitive. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {string} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text to find. Use double quotes (empty text) to match the first character in the search string. + * Wildcard characters are not allowed. + * @param {ApiRange | ApiName | string} arg2 - The text containing the text to find. + * @param {ApiRange | ApiName | number} [arg3] - Specifies the character at which to start the search. The first character in the search string is character number 1. + * If omitted, this parameter is equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.FIND = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Finds the specified substring within another string and is intended for languages that use the double-byte character set (DBCS) like Japanese, Chinese, Korean etc. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {string} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text to find. Use double quotes (empty text) to match the first character in the search string. + * Wildcard characters are not allowed. + * @param {ApiRange | ApiName | string} arg2 - The text containing the text to find. + * @param {ApiRange | ApiName | number} [arg3] - Specifies the character at which to start the search. The first character in the search string is character number 1. + * If omitted, this parameter is equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.FINDB = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number to the specified number of decimals and returns the result as text with or without commas. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @param {boolean} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number to round and convert to text. + * @param {ApiRange | ApiName | number} [arg2] - The number of digits to the right of the decimal point. If omitted, the function will assume it to be 2. + * @param {ApiRange | ApiName | boolean} [arg3] - Specifies whether do display commas in the returned text (false or omitted) or not (true). + * @returns {string} */ -ApiWorksheetFunction.prototype.FIXED = function (arg1, arg2, arg3) { return 0; }; +ApiWorksheetFunction.prototype.FIXED = function (arg1, arg2, arg3) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the specified number of characters from the start of a text string. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text string containing the characters to extract. + * @param {ApiRange | ApiName | number} [arg2] - A number of the substring characters. It must be greater than or equal to 0. + * @returns {string} */ -ApiWorksheetFunction.prototype.LEFT = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.LEFT = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Extracts the substring from the specified string starting from the left character and is intended for languages that use the double-byte character set (DBCS) like Japanese, Chinese, Korean etc. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text string containing the characters to extract. + * @param {ApiRange | ApiName | number} [arg2] - A number of the substring characters, based on bytes. + * @returns {string} */ -ApiWorksheetFunction.prototype.LEFTB = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.LEFTB = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the number of characters in a text string. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text whose length will be returned. Spaces are considered as characters. + * @returns {number} */ ApiWorksheetFunction.prototype.LEN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Analyses the specified string and returns the number of characters it contains and is intended for languages that use the double-byte character set (DBCS) like Japanese, Chinese, Korean etc. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text whose length will be returned. Spaces are considered as characters. + * @returns {number} */ ApiWorksheetFunction.prototype.LENB = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts all letters in a text string to lowercase. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text to convert to lowercase. The text characters that are not letters are not changed. + * @returns {string} */ -ApiWorksheetFunction.prototype.LOWER = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.LOWER = function (arg1) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the characters from the middle of a text string, given a starting position and length. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text string from which to extract the characters. + * @param {ApiRange | ApiName | number} arg2 - The position of the first character to extract. The first text character is 1. + * @param {ApiRange | ApiName | number} arg3 - A number of the characters to extract. + * @returns {string} */ -ApiWorksheetFunction.prototype.MID = function (arg1, arg2, arg3) { return 0; }; +ApiWorksheetFunction.prototype.MID = function (arg1, arg2, arg3) { return ""; }; /** - * Returns the result of calculating the function. + * Extracts the characters from the specified string starting from any position and is intended for languages that use the double-byte character set (DBCS) like Japanese, Chinese, Korean etc. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text string from which to extract the characters. + * @param {ApiRange | ApiName | number} arg2 - The position of the first character to extract. The first text character is 1. + * @param {ApiRange | ApiName | number} arg3 - A number of the characters to extract, based on bytes. + * @returns {string} */ -ApiWorksheetFunction.prototype.MIDB = function (arg1, arg2, arg3) { return 0; }; +ApiWorksheetFunction.prototype.MIDB = function (arg1, arg2, arg3) { return ""; }; /** - * Returns the result of calculating the function. + * Converts text to a number, in a locale-independent way. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {string} [arg2]. - * @param {string} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The string representing a number to convert. + * @param {ApiRange | ApiName | string} [arg2] - The character used as the decimal separator in the string. + * @param {ApiRange | ApiName | string} [arg3] - The character used as the group separator in the string. + * @returns {number} */ ApiWorksheetFunction.prototype.NUMBERVALUE = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a text string to proper case: the first letter in each word to uppercase, and all other letters to lowercase. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text enclosed in quotation marks, a formula that returns text, or a reference to a cell containing text to partially capitalize. + * @returns {string} */ -ApiWorksheetFunction.prototype.PROPER = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.PROPER = function (arg1) { return ""; }; /** - * Returns the result of calculating the function. + * Replaces part of a text string with a different text string. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {string} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text where some characters will be replaced. + * @param {ApiRange | ApiName | number} arg2 - The position of the character in the original text that will be replaced with the new text. + * @param {ApiRange | ApiName | number} arg3 - The number of characters in the original text that will be replaced. + * @param {ApiRange | ApiName | string} arg4 - The text that will replace characters in the original text. + * @returns {string} */ -ApiWorksheetFunction.prototype.REPLACE = function (arg1, arg2, arg3, arg4) { return 0; }; +ApiWorksheetFunction.prototype.REPLACE = function (arg1, arg2, arg3, arg4) { return ""; }; /** - * Returns the result of calculating the function. + * Replaces a set of characters, based on the number of characters and the start position specified, with a new set of characters and is intended for languages that use the double-byte character set (DBCS) like Japanese, Chinese, Korean etc. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {string} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text where some characters will be replaced. + * @param {ApiRange | ApiName | number} arg2 - The position of the character in the original text that will be replaced with the new text. + * @param {ApiRange | ApiName | number} arg3 - The number of characters in the original text that will be replaced, based on bytes. + * @param {ApiRange | ApiName | string} arg4 - The text that will replace characters in the original text. + * @returns {string} */ -ApiWorksheetFunction.prototype.REPLACEB = function (arg1, arg2, arg3, arg4) { return 0; }; +ApiWorksheetFunction.prototype.REPLACEB = function (arg1, arg2, arg3, arg4) { return ""; }; /** - * Returns the result of calculating the function. + * Repeats text a given number of times. Use this function to fill a cell with a number of instances of a text string. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text that will be repeated. + * @param {ApiRange | ApiName | number} arg2 - A positive number specifying the number of times to repeat text. + * @returns {string} */ -ApiWorksheetFunction.prototype.REPT = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.REPT = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the specified number of characters from the end of a text string. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text string that contains the characters to extract. + * @param {ApiRange | ApiName | number} [arg2] - A number of the substring characters. If it is omitted, the function will assume it to be 1. + * @returns {string} */ -ApiWorksheetFunction.prototype.RIGHT = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.RIGHT = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Extracts a substring from a string starting from the right-most character, based on the specified number of characters and is intended for languages that use the double-byte character set (DBCS) like Japanese, Chinese, Korean etc. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text string that contains the characters to extract. + * @param {ApiRange | ApiName | number} [arg2] - A number of the substring characters, based on bytes. + * @returns {string} */ -ApiWorksheetFunction.prototype.RIGHTB = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.RIGHTB = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the number of the character at which a specific character or text string is first found, reading left to right (not case-sensitive). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {string} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text to find. The ? and * wildcard characters can be used. Use ~? and ~* to find the ? and * characters. + * @param {ApiRange | ApiName | string} arg2 - The text where to search for the specified text. + * @param {ApiRange | ApiName | number} [arg3] - The character number in the search text, counting from the left, at which to start searching. If omitted, 1 is used. + * @returns {number} */ ApiWorksheetFunction.prototype.SEARCH = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the location of the specified substring in a string and is intended for languages that use the double-byte character set (DBCS) like Japanese, Chinese, Korean etc. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {string} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text to find. The ? and * wildcard characters can be used. Use ~? and ~* to find the ? and * characters. + * @param {ApiRange | ApiName | string} arg2 - The text where to search for the specified text. + * @param {ApiRange | ApiName | number} [arg3] - The character number in the search text, counting from the left, at which to start searching. If omitted, 1 is used. + * @returns {number} */ ApiWorksheetFunction.prototype.SEARCHB = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Replaces existing text with new text in a text string. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {string} arg2. - * @param {string} arg3. - * @param {string} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text or the reference to a cell containing text in which the characters will be substituted. + * @param {ApiRange | ApiName | string} arg2 - The existing text to replace. If the case of the original text does not match the case of text, the function will not replace the text. + * @param {ApiRange | ApiName | string} arg3 - The text to replace the original text with. + * @param {ApiRange | ApiName | string} [arg4] - Specifies which occurrence of the original text to replace. If omitted, every instance of the original text will be replaced. + * @returns {string} */ -ApiWorksheetFunction.prototype.SUBSTITUTE = function (arg1, arg2, arg3, arg4) { return 0; }; +ApiWorksheetFunction.prototype.SUBSTITUTE = function (arg1, arg2, arg3, arg4) { return ""; }; /** - * Returns the result of calculating the function. + * Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string | boolean} arg1 - The value to test. + * @returns {ApiRange | ApiName | string} */ -ApiWorksheetFunction.prototype.T = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.T = function (arg1) { return new ApiRange(); }; /** - * Returns the result of calculating the function. + * Converts a value to text in a specific number format. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {string} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string} arg1 - A number, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value. + * @param {ApiRange | ApiName | string} arg2 - A number format in the text form from the Number format combo box on the Home tab. + * @returns {string} */ -ApiWorksheetFunction.prototype.TEXT = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.TEXT = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Removes all spaces from a text string except for single spaces between words. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text from which the spaces will be removed. + * @returns {string} */ -ApiWorksheetFunction.prototype.TRIM = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.TRIM = function (arg1) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the Unicode character referenced by the given numeric value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The Unicode number representing a character. + * @returns {string} */ -ApiWorksheetFunction.prototype.UNICHAR = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.UNICHAR = function (arg1) { return ""; }; /** - * Returns the result of calculating the function. + * Returns the number (code point) corresponding to the first character of the text. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The character for which the Unicode value will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.UNICODE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a text string to all uppercase letters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text which will be converted to uppercase, a reference or a text string. + * @returns {string} */ -ApiWorksheetFunction.prototype.UPPER = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.UPPER = function (arg1) { return ""; }; /** - * Returns the result of calculating the function. + * Converts a text string that represents a number to a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text enclosed in quotation marks or a reference to a cell containing the text which will be converted to a number. + * @returns {number} */ ApiWorksheetFunction.prototype.VALUE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the average of the absolute deviations of data points from their mean. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | number[]} args - Up to 255 numeric values for which the average of the absolute deviations will be returned. The first argument is required, + * subsequent arguments are optional. Arguments can be numbers, names, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.AVEDEV = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the average (arithmetic mean) of the specified arguments. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | number[]} args - Up to 255 numeric values for which the average value will be returned. The first argument is required, + * subsequent arguments are optional. Arguments can be numbers, names, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.AVERAGE = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the average (arithmetic mean) of the specified arguments, evaluating text and false in arguments as 0; true evaluates as 1. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string | number[]} args - Up to 255 numeric values for which the average value will be returned. The first argument is required, + * subsequent arguments are optional. Arguments can be numbers, text, or logical values, such as true and false, names, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.AVERAGEA = function () { return 0; }; /** - * Returns the result of calculating the function. + * Finds the average (arithmetic mean) for the cells specified by a given condition or criteria. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {any} arg2. - * @param {ApiRange} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells which will be evaluated. + * @param {ApiRange | ApiName | number | string} arg2 - The condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average. + * @param {ApiRange | ApiName} [arg3] - The actual cells to be used to find the average. If omitted, the cells in the range are used. + * @returns {number} */ ApiWorksheetFunction.prototype.AVERAGEIF = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Finds the average (arithmetic mean) for the cells specified by a given set of conditions or criteria. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells which will be evaluated. + * @param {ApiRange | ApiName | number | string} arg2 - The first condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average. + * @param {ApiRange | ApiName} [arg3] - The actual cells to be used to find the average. If omitted, the cells in the range are used. + * @param {ApiRange | ApiName | number | string} [arg4] - Up to 127 additional conditions or criteria in the form of a number, expression, or text that defines which cells will be used to find the average. + * These arguments are optional. + * @param {ApiRange | ApiName} [arg5] - Up to 127 actual ranges to be used to find the average. If omitted, the cells in the range are used. These arguments are optional. + * @returns {number} */ ApiWorksheetFunction.prototype.AVERAGEIFS = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cumulative beta probability density function. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value between A and B at which to evaluate the function. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | number} [arg4] - An optional lower bound to the interval of x (A). If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg5] - An optional upper bound to the interval of x (B). If omitted, it is equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.BETADIST = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the beta probability distribution function. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @param {number} [arg5]. - * @param {number} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value between A and B at which to evaluate the function. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | boolean} arg4 - Specifies if this is the cumulative distribution function (true) or the probability density function (false). + * @param {ApiRange | ApiName | number} [arg5] - An optional lower bound to the interval of x (A). If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg6] - An optional upper bound to the interval of x (B). If omitted, it is equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.BETA_DIST = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the cumulative beta probability density function (BETA_DIST). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the beta distribution. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | number} [arg4] - An optional lower bound to the interval of x (A). If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg5] - An optional upper bound to the interval of x (B). If omitted, it is equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.BETA_INV = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the cumulative beta probability density function for a specified beta distribution (BETADIST). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the beta distribution. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution which must be greater than 0. + * @param {ApiRange | ApiName | number} [arg4] - An optional lower bound to the interval of x (A). If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg5] - An optional upper bound to the interval of x (B). If omitted, it is equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.BETAINV = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the individual term binomial distribution probability. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of successes in trials. + * @param {ApiRange | ApiName | number} arg2 - The number of independent trials. + * @param {ApiRange | ApiName | number} arg3 - The probability of success on each trial. + * @param {ApiRange | ApiName | boolean} arg4 - Specifies if this is the cumulative distribution function (true) or the probability mass function (false). + * @returns {number} */ ApiWorksheetFunction.prototype.BINOMDIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the individual term binomial distribution probability. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of successes in trials. + * @param {ApiRange | ApiName | number} arg2 - The number of independent trials. + * @param {ApiRange | ApiName | number} arg3 - The probability of success on each trial. + * @param {ApiRange | ApiName | boolean} arg4 - Specifies if this is the cumulative distribution function (true) or the probability mass function (false). + * @returns {number} */ ApiWorksheetFunction.prototype.BINOM_DIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the probability of a trial result using a binomial distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of independent trials. + * @param {ApiRange | ApiName | number} arg2 - The probability of success on each trial. + * @param {ApiRange | ApiName | number} arg3 - The minimum number of successes in the trials to calculate probability for, a numeric value greater than or equal to 0. + * @param {ApiRange | ApiName | number} [arg4] - The maximum number of successes in the trials to calculate probability for, + * a numeric value greater than the minimum number of successes and less than or equal to trials. + * @returns {number} */ -ApiWorksheetFunction.prototype.BINOM_DIST.RANGE = function (arg1, arg2, arg3, arg4) { return 0; }; +ApiWorksheetFunction.prototype.BINOM_DIST_RANGE = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of Bernoulli trials. + * @param {ApiRange | ApiName | number} arg2 - The probability of success on each trial, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg3 - The criterion value, a number between 0 and 1 inclusive. + * @returns {number} */ ApiWorksheetFunction.prototype.BINOM_INV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the right-tailed probability of the chi-squared distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which the distribution will be evaluated, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ ApiWorksheetFunction.prototype.CHIDIST = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the right-tailed probability of the chi-squared distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the chi-squared distribution, a value between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - The number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ ApiWorksheetFunction.prototype.CHIINV = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the left-tailed probability of the chi-squared distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {boolean} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which the distribution will be evaluated, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | boolean} arg3 - A logical value that determines the form of the function. If this argument is equal to true, + * the cumulative distribution function is returned; if it is equal to false, the probability density function is returned. + * @returns {number} */ ApiWorksheetFunction.prototype.CHISQ_DIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the right-tailed probability of the chi-squared distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which the distribution will be evaluated, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ ApiWorksheetFunction.prototype.CHISQ_DIST_RT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the left-tailed probability of the chi-squared distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the chi-squared distribution, a value between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2- The number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ ApiWorksheetFunction.prototype.CHISQ_INV = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the right-tailed probability of the chi-squared distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the chi-squared distribution, a value between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - The number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ -ApiWorksheetFunction.prototype.CHISQ_INV.RT = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.CHISQ_INV_RT = function (arg1, arg2) { return 0; }; /** // * Returns the result of calculating the function. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] // * @param {any} arg1. // * @param {any} arg2. // * @returns {number | string | boolean} @@ -3306,3958 +3987,3789 @@ ApiWorksheetFunction.prototype.CHISQ_INV.RT = function (arg1, arg2) { return 0; // ApiWorksheetFunction.prototype.CHITEST = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. + * Returns the test for independence: the value from the chi-squared distribution for the statistic and the appropriate degrees of freedom. + * @memberof ApiWorksheetFunction + * @param {ApiRange | ApiName | number | string | boolean} arg1 - The range of data that contains observations to test against expected values. + * @param {ApiRange | ApiName | number | string | boolean} arg2 - The range of data that contains the ratio of the product of row totals and column totals to the grand total. + * @returns {number} + */ +ApiWorksheetFunction.prototype.CHITEST = function (arg1, arg2) { return 0; }; + +/** +// * Returns the test for independence: the value from the chi-squared distribution for the statistic and the appropriate degrees of freedom. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the range of data that contains observations to test against expected values. +// * @param {any} arg2 Is the range of data that contains the ratio of the product of row totals and column totals to the grand total. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.CHISQ_TEST = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the confidence interval for a population mean, using a normal distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The significance level used to compute the confidence level, a number greater than 0 and less than 1. + * @param {ApiRange | ApiName | number} arg2 - The population standard deviation for the data range and is assumed to be known. This value must be greater than 0. + * @param {ApiRange | ApiName | number} arg3 - The sample size. + * @returns {number} */ ApiWorksheetFunction.prototype.CONFIDENCE = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the confidence interval for a population mean, using a normal distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The significance level used to compute the confidence level, a number greater than 0 and less than 1. + * @param {ApiRange | ApiName | number} arg2 - The population standard deviation for the data range and is assumed to be known. This value must be greater than 0. + * @param {ApiRange | ApiName | number} arg3 - The sample size. + * @returns {number} */ ApiWorksheetFunction.prototype.CONFIDENCE_NORM = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the confidence interval for a population mean, using a Student's t distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The significance level used to compute the confidence level, a number greater than 0 and less than 1. + * @param {ApiRange | ApiName | number} arg2 - The population standard deviation for the data range and is assumed to be known. This value must be greater than 0. + * @param {ApiRange | ApiName | number} arg3 - The sample size. + * @returns {number} */ ApiWorksheetFunction.prototype.CONFIDENCE_T = function (arg1, arg2, arg3) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the correlation coefficient between two data sets. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is a cell range of values. The values should be numbers, names, arrays, or references that contain numbers. +// * @param {any} arg2 Is a second cell range of values. The values should be numbers, names, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.CORREL = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Counts a number of cells in a range that contains numbers ignoring empty cells or those contaning text. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {string | number | boolean | Array | ApiRange | ApiName} args - Up to 255 items, or ranges to count numbers. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values and text representations of numbers, ranges, names, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.COUNT = function () { return 0; }; /** - * Returns the result of calculating the function. + * Counts a number of cells in a range that are not empty. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {string | number | boolean | Array | ApiRange | ApiName} args - Up to 255 items, or ranges to count values. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values, text strings, ranges, names, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.COUNTA = function () { return 0; }; /** - * Returns the result of calculating the function. + * Counts a number of empty cells in a specified range of cells. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range to count the empty cells. + * @returns {number} */ ApiWorksheetFunction.prototype.COUNTBLANK = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Counts a number of cells within a range that meet the given condition. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells to count nonblank cells. + * @param {ApiRange | ApiName | number | string} arg2 - The condition in the form of a number, expression, or text that defines which cells will be counted. + * @returns {number} */ ApiWorksheetFunction.prototype.COUNTIF = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Counts a number of cells specified by a given set of conditions or criteria. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The first range of cells to count nonblank cells. + * @param {ApiRange | ApiName | number | string} arg2 - The first condition in the form of a number, expression, or text that defines which cells will be counted. + * @param {ApiRange | ApiName} arg3 - Up to 127 additional ranges of cells to count nonblank cells. This argument is optional. + * @param {ApiRange | ApiName | number | string} arg4 - Up to 127 additional conditions in the form of a number, expression, or text that define which cells will be counted. + * @returns {number} */ ApiWorksheetFunction.prototype.COUNTIFS = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns covariance, the average of the products of deviations for each data point pair in two data sets. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first cell range of integers and must be numbers, arrays, or references that contain numbers. +// * @param {any} arg2 Is the second cell range of integers and must be numbers, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.COVAR = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns population covariance, the average of the products of deviations for each data point pair in two data sets. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first cell range of integers and must be numbers, arrays, or references that contain numbers. +// * @param {any} arg2 Is the second cell range of integers and must be numbers, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.COVARIANCE_P = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns sample covariance, the average of the products of deviations for each data point pair in two data sets. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first cell range of integers and must be numbers, arrays, or references that contain numbers. +// * @param {any} arg2 Is the second cell range of integers and must be numbers, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.COVARIANCE_S = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of Bernoulli trials. + * @param {ApiRange | ApiName | number} arg2 - The probability of success on each trial, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg3 - The criterion value, a number between 0 and 1 inclusive. + * @returns {number} */ ApiWorksheetFunction.prototype.CRITBINOM = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sum of squares of deviations of data points from their sample mean. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | number[]} args - Up to 255 numerical values for which to find the sum of squares of deviations. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.DEVSQ = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the exponential distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {boolean} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value of the x function, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The lambda parameter value, a positive number. + * @param {ApiRange | ApiName | boolean} arg3 - A logical value that determines the function form. If this parameter is true, + * the function will return the cumulative distribution function, if it is false, it will return the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.EXPON_DIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the exponential distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {boolean} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value of the x function, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The lambda parameter value, a positive number. + * @param {ApiRange | ApiName | boolean} arg3 - A logical value that determines the function form. If this parameter is true, + * the function will return the cumulative distribution function, if it is false, it will return the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.EXPONDIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | number} arg3 - The denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value that determines the function form. If this parameter is true, + * the function will return the cumulative distribution function, if it is false, it will return the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.F_DIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | number} arg3 - The denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ ApiWorksheetFunction.prototype.FDIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | number} arg3 - The denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ -ApiWorksheetFunction.prototype.F_DIST.RT = function (arg1, arg2, arg3) { return 0; }; +ApiWorksheetFunction.prototype.F_DIST_RT = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the F cumulative distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - The numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | number} arg3 - The denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ ApiWorksheetFunction.prototype.F_INV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the (right-tailed) F probability distribution: if p = FDIST(x,...), then FINV(p,...) = x. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the F cumulative distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - The numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | number} arg3 - The denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ ApiWorksheetFunction.prototype.FINV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the F cumulative distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - The numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param {ApiRange | ApiName | number} arg3 - The denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @returns {number} */ -ApiWorksheetFunction.prototype.F_INV.RT = function (arg1, arg2, arg3) { return 0; }; +ApiWorksheetFunction.prototype.F_INV_RT = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Fisher transformation. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for the transformation, a number between -1 and 1, excluding -1 and 1. + * @returns {number} */ ApiWorksheetFunction.prototype.FISHER = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to perform the inverse of the transformation. + * @returns {number} */ ApiWorksheetFunction.prototype.FISHERINV = function (arg1) { return 0; }; /** -// * Returns the result of calculating the function. +// * Calculates, or predicts, a future value along a linear trend by using existing values. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {number} arg1. -// * @param {any} arg2. -// * @param {any} arg3. +// * @param {ApiRange | ApiName | number} arg1 Is the data point for which you want to predict a value and must be a numeric value. +// * @param {any} arg2 Is the dependent array or range of numeric data. +// * @param {any} arg3 Is the independent array or range of numeric data. The variance of Known_x's must not be zero. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.FORECAST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * A numeric value that specifies which function should be used to aggregate identical time values in the timeline data range. + * 1 (or omitted) - AVERAGE. + * 2 - COUNT. + * 3 - COUNTA. + * 4 - MAX. + * 5 - MEDIAN. + * 6 - MIN. + * 7 - SUM. + * @typedef {(1 | 2 | 3 | 4 | 5 | 6 | 7)} Aggregation + */ + +/** + * РЎalculates or predicts a future value based on existing (historical) values by using the AAA version of the Exponential Smoothing (ETS) algorithm. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {ApiRange} arg2. - * @param {ApiRange} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @param {number} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A date for which a new value will be predicted. Must be after the last date in the timeline. + * @param {ApiRange | ApiName | number[]} arg2 - A range or an array of numeric data that determines the historical values for which a new point will be predicted. + * @param {ApiRange | ApiName} arg3 - A range of date/time values that correspond to the historical values. + * The timeline range must be of the same size as the second argument. Date/time values must have a constant step between them and can't be zero. + * @param {ApiRange | ApiName | number} [arg4] - An optional numeric value that specifies the length of the seasonal pattern. The default value of 1 indicates seasonality is detected automatically. + * The 0 value means no seasonality. + * @param {ApiRange | ApiName | number} [arg5] - An optional numeric value to handle missing values. The default value of 1 replaces missing values by interpolation, and 0 replaces them with zeros. + * @param {ApiRange | ApiName | number} [arg6] - An optional numeric value to aggregate multiple values with the same time stamp. + * @returns {number} */ ApiWorksheetFunction.prototype.FORECAST_ETS = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a confidence interval for the forecast value at the specified target date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {ApiRange} arg2. - * @param {ApiRange} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @param {number} [arg6]. - * @param {number} [arg7]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A date for which a new value will be predicted. Must be after the last date in the timeline. + * @param {ApiRange | ApiName | number[]} arg2 - A range or an array of numeric data that determines the historical values for which a new point will be predicted. + * @param {ApiRange | ApiName} arg3 - A range of date/time values that correspond to the historical values. + * The timeline range must be of the same size as the second argument. Date/time values must have a constant step between them and can't be zero. + * @param {ApiRange | ApiName | number} [arg4] - A number between 0 and 1 that shows the confidence level for the calculated confidence interval. The default value is .95. + * @param {ApiRange | ApiName | number} [arg5] - An optional numeric value that specifies the length of the seasonal pattern. The default value of 1 indicates seasonality is detected automatically. + * The 0 value means no seasonality. + * @param {ApiRange | ApiName | number} [arg6] - An optional numeric value to handle missing values. The default value of 1 replaces missing values by interpolation, and 0 replaces them with zeros. + * @param {ApiRange | ApiName | number} [arg7] - An optional numeric value to aggregate multiple values with the same time stamp. + * @returns {number} */ -ApiWorksheetFunction.prototype.FORECAST_ETS.CONFINT = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7) { return 0; }; +ApiWorksheetFunction.prototype.FORECAST_ETS_CONFINT = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the length of the repetitive pattern an application detects for the specified time series. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {ApiRange} arg2. - * @param {number} [arg3]. - * @param {number} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - A range or an array of numeric data that determines the historical values for which a new point will be predicted. + * @param {ApiRange | ApiName} arg2 - A range of date/time values that correspond to the historical values. + * The timeline range must be of the same size as the second argument. Date/time values must have a constant step between them and can't be zero. + * @param {ApiRange | ApiName | number} [arg3] - An optional numeric value to handle missing values. The default value of 1 replaces missing values by interpolation, and 0 replaces them with zeros. + * @param {ApiRange | ApiName | number} [arg4] - An optional numeric value to aggregate multiple values with the same time stamp. + * @returns {number} */ -ApiWorksheetFunction.prototype.FORECAST_ETS.SEASONALITY = function (arg1, arg2, arg3, arg4) { return 0; }; +ApiWorksheetFunction.prototype.FORECAST_ETS_SEASONALITY = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. - * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {ApiRange} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @param {number} [arg6]. - * @returns {number | string | boolean} + * A numeric value between 1 and 8 that specifies which statistic will be returned. + * 1 - Alpha parameter of ETS algorithm - the base value parameter. + * 2 - Beta parameter of ETS algorithm - the trend value parameter. + * 3 - Gamma parameter of ETS algorithm - the seasonality value parameter. + * 4 - MASE (mean absolute scaled error) metric - a measure of the accuracy of forecasts. + * 5 - SMAPE (symmetric mean absolute percentage error) metric - a measure of the accuracy based on percentage errors. + * 6 - MAE (mean absolute error) metric - a measure of the accuracy of forecasts. + * 7 - RMSE (root mean squared error) metric - a measure of the differences between predicted and observed values. + * 8 - Step size detected in the timeline. + * @typedef {(1 | 2 | 3 | 4 | 5 | 6 | 7 | 8)} StatisticType */ -ApiWorksheetFunction.prototype.FORECAST_ETS.STAT = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** -// * Returns the result of calculating the function. + * Returns the requested statistic for the forecast. + * @memberof ApiWorksheetFunction + * @param {ApiRange | ApiName | number[]} arg1 - A range or an array of numeric data that determines the historical values for which a new point will be predicted. + * @param {ApiRange | ApiName} arg2 - A range of date/time values that correspond to the historical values. + * The timeline range must be of the same size as the second argument. Date/time values must have a constant step between them and can't be zero. + * @param {ApiRange | ApiName | number} arg3 - A number between 1 and 8, indicating which statistic will be returned for the calculated forecast. + * @param {ApiRange | ApiName | number} [arg4] - An optional numeric value that specifies the length of the seasonal pattern. The default value of 1 indicates seasonality is detected automatically. + * The 0 value means no seasonality. + * @param {ApiRange | ApiName | number} [arg5] - An optional numeric value to handle missing values. The default value of 1 replaces missing values by interpolation, and 0 replaces them with zeros. + * @param {ApiRange | ApiName | number} [arg6] - An optional numeric value to aggregate multiple values with the same time stamp. + * @returns {number} + */ +ApiWorksheetFunction.prototype.FORECAST_ETS_STAT = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; + +/** +// * Calculates, or predicts, a future value along a linear trend by using existing values. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {number} arg1. -// * @param {any} arg2. -// * @param {any} arg3. +// * @param {ApiRange | ApiName | number} arg1 Is the data point for which you want to predict a value and must be a numeric value. +// * @param {any} arg2 Is the dependent array or range of numeric data. +// * @param {any} arg3 Is the independent array or range of numeric data. The variance of Known_x's must not be zero. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.FORECAST_LINEAR = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Calculates how often values occur within a range of values and then returns the first value of the returned vertical array of numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {ApiRange} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - An array of values or the selected range for which the frequencies will be counted (blanks and text are ignored). + * @param {ApiRange | ApiName | number[]} arg2 - An array of intervals or the selected range into which the values in the first range will be grouped. + * @returns {number} */ ApiWorksheetFunction.prototype.FREQUENCY = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the result of an F-test, the two-tailed probability that the variances in Array1 and Array2 are not significantly different. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first array or range of data and can be numbers or names, arrays, or references that contain numbers (blanks are ignored). +// * @param {any} arg2 Is the second array or range of data and can be numbers or names, arrays, or references that contain numbers (blanks are ignored). // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.FTEST = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the result of an F-test, the two-tailed probability that the variances in Array1 and Array2 are not significantly different. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first array or range of data and can be numbers or names, arrays, or references that contain numbers (blanks are ignored). +// * @param {any} arg2 Is the second array or range of data and can be numbers or names, arrays, or references that contain numbers (blanks are ignored). // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.F_TEST = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the gamma function value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the gamma function will be calculated. + * @returns {number} */ ApiWorksheetFunction.prototype.GAMMA = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the gamma distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which the distribution will be calculated, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution, a positive number. If this parameter is equal to 1, the function returns the standard gamma distribution. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true> or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. If it is false, the function returns the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.GAMMA_DIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the gamma distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which the distribution will be calculated, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution, a positive number. If this parameter is equal to 1, the function returns the standard gamma distribution. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true> or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. If it is false, the function returns the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.GAMMADIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The probability associated with the gamma distribution, a number between 0 and 1, inclusive. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution, a positive number. If this parameter is equal to 1, the function returns the standard gamma distribution. + * @returns {number} */ ApiWorksheetFunction.prototype.GAMMA_INV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the gamma cumulative distribution: if p = GAMMADIST(x,...), then GAMMAINV(p,...) = x. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The probability associated with the gamma distribution, a number between 0 and 1, inclusive. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution, a positive number. If this parameter is equal to 1, the function returns the standard gamma distribution. + * @returns {number} */ ApiWorksheetFunction.prototype.GAMMAINV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the natural logarithm of the gamma function. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the natural logarithm of the gamma function will be calculated, a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.GAMMALN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the natural logarithm of the gamma function. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the natural logarithm of the gamma function will be calculated, a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.GAMMALN_PRECISE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Calculates the probability that a member of a standard normal population will fall between the mean and arg1 standard deviations from the mean. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the distribution will be calculated. + * @returns {number} */ ApiWorksheetFunction.prototype.GAUSS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the geometric mean of positive numeric data. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | number[] | ApiName} args - Up to 255 numeric values for which the geometric mean will be calculated. + * Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.GEOMEAN = function () { return 0; }; /** - * Returns the result of calculating the function. + * Calculates predicted exponential growth by using existing data. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {ApiRange} [arg2]. - * @param {ApiRange} [arg3]. - * @param {boolean} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The set of y-values from the y = b*m^x equation, an array or range of positive numbers. + * @param {ApiRange | ApiName | number[]} [arg2] - An optional set of x-values from the y = b*m^x equation, an array or range of positive numbers that has the same size as the set of y-values. + * @param {ApiRange | ApiName | number[]} [arg3] - New x-values for which the function will return the corresponding y-values. + * @param {ApiRange | ApiName | boolean} [arg4] - A logical value: the constant b is calculated normally if this parameter is set to true, + * and b is set equal to 1 if the parameter is false or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.GROWTH = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | number[] | ApiName} args - Up to 255 numeric values for which the harmonic mean will be calculated. + * Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.HARMEAN = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hypergeometric distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of successes in the sample. + * @param {ApiRange | ApiName | number} arg2 - The size of the sample. + * @param {ApiRange | ApiName | number} arg3 - The number of successes in the population. + * @param {ApiRange | ApiName | number} arg4 - The population size. + * @returns {number} */ ApiWorksheetFunction.prototype.HYPGEOMDIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hypergeometric distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @param {boolean} arg5. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of successes in the sample. + * @param {ApiRange | ApiName | number} arg2 - The size of the sample. + * @param {ApiRange | ApiName | number} arg3 - The number of successes in the population. + * @param {ApiRange | ApiName | number} arg4 - The population size. + * @param {ApiRange | ApiName | boolean} arg5 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. If it is false, the function returns the probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.HYPGEOM_DIST = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** -// * Returns the result of calculating the function. +// * Calculates the point at which a line will intersect the y-axis by using a best-fit regression line plotted through the known x-values and y-values. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the dependent set of observations or data and can be numbers or names, arrays, or references that contain numbers. +// * @param {any} arg2 Is the independent set of observations or data and can be numbers or names, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.INTERCEPT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the kurtosis of a data set. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | number[] | ApiName} args - Up to 255 numeric values for which the kurtosis will be calculated. + * Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.KURT = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the k-th largest value in a data set. For example, the fifth largest number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of data for which the k-th largest value will be determined. + * @param {ApiRange | ApiName | number} arg2 - The position (from the largest) in the array or cell range of data to return. + * @returns {number} */ ApiWorksheetFunction.prototype.LARGE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns statistics that describe a linear trend matching known data points, by fitting a straight line using the least squares method. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {ApiRange} [arg2]. - * @param {boolean} [arg3]. - * @param {boolean} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The set of y-values from the y = mx + b equation. + * @param {ApiRange | ApiName} [arg2] - An optional set of x-values from the y = mx + b equation. + * @param {ApiRange | ApiName | boolean} [arg3] - A logical value: the constant b is calculated normally if this parameter is set to true or omitted, + * and b is set equal to 0 if the parameter is false. + * @param {ApiRange | ApiName | boolean} [arg4] - A logical value: return additional regression statistics if this parameter is set to true, + * and return m-coefficients and the constant b if the parameter is false or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.LINEST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns statistics that describe an exponential curve matching known data points. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {ApiRange} [arg2]. - * @param {boolean} [arg3]. - * @param {boolean} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | ApiRange} arg1 - The set of y-values from the y = b*m^x equation. + * @param {ApiRange | ApiName | ApiRange} [arg2] - An optional set of x-values from the y = b*m^x equation. + * @param {ApiRange | ApiName | boolean} [arg3] - A logical value: the constant b is calculated normally if this parameter is set to true or omitted, + * and b is set equal to 1 if the parameter is false. + * @param {ApiRange | ApiName | boolean} [arg4] - A logical value: return additional regression statistics if this parameter is set to true, + * and return m-coefficients and the constant b if the parameter is false or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.LOGEST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with the specified parameters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the lognormal distribution, a number between 0 and 1, inclusive. + * @param {ApiRange | ApiName | number} arg2 - The mean of ln(x). + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of ln(x), a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.LOGINV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the lognormal distribution of x, where ln(x) is normally distributed with the specified parameters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function, a positive number. + * @param {ApiRange | ApiName | number} arg2 - The mean of ln(x). + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of ln(x), a positive number. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.LOGNORM_DIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with the specified parameters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability associated with the lognormal distribution, a number between 0 and 1, inclusive. + * @param {ApiRange | ApiName | number} arg2 - The mean of ln(x). + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of ln(x), a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.LOGNORM_INV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cumulative lognormal distribution of x, where ln(x) is normally distributed with the specified parameters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function, a positive number. + * @param {ApiRange | ApiName | number} arg2 - The mean of ln(x). + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of ln(x), a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.LOGNORMDIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the largest value in a set of values. Ignores logical values and text. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | number[] | ApiRange | ApiName} args - Up to 255 numeric values for which the largest number will be returned. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.MAX = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the largest value in a set of values. Does not ignore logical values and text. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | string | boolean | Array | ApiRange | ApiName} args - Up to 255 values (number, text, logical value) for which the largest value will be returned. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values and text representations of numbers, names, ranges, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.MAXA = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the median, or the number in the middle of the set of given numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | number[] | ApiRange | ApiName} args - Up to 255 numeric values for which the median will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.MEDIAN = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the smallest number in a set of values. Ignores logical values and text. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | number[] | ApiRange | ApiName} args - Up to 255 numeric values for which the smallest number will be returned. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.MIN = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the smallest value in a set of values. Does not ignore logical values and text. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | string | boolean | Array | ApiRange | ApiName} args - Up to 255 values (number, text, logical value) for which the smallest value will be returned. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values and text representations of numbers, names, ranges, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.MINA = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the most frequently occurring, or repetitive, value in an array or range of data. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.MODE = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns a vertical array of the most frequently occurring, or repetitive, values in an array or range of data. For a horizontal array, use =TRANSPOSE(MODE.MULT(number1,number2,...)). // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.MODE_MULT = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the most frequently occurring, or repetitive, value in an array or range of data. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.MODE_SNGL = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the negative binomial distribution, the probability that there will be the specified number of failures before the last success, with the specified probability of a success. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of failures. + * @param {ApiRange | ApiName | number} arg2 - The threshold number of successes. + * @param {ApiRange | ApiName | number} arg3 - The probability of a success; a number between 0 and 1. + * @returns {number} */ ApiWorksheetFunction.prototype.NEGBINOMDIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the negative binomial distribution, the probability that there will be the specified number of failures before the last success, with the specified probability of a success. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of failures. + * @param {ApiRange | ApiName | number} arg2 - The threshold number of successes. + * @param {ApiRange | ApiName | number} arg3 - The probability of a success; a number between 0 and 1. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.NEGBINOM_DIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the normal cumulative distribution for the specified mean and standard deviation. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the distribution will be returned. + * @param {ApiRange | ApiName | number} arg2 - The arithmetic mean of the distribution. + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of the distribution, a positive number. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.NORMDIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the normal distribution for the specified mean and standard deviation. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the distribution will be returned. + * @param {ApiRange | ApiName | number} arg2 - The arithmetic mean of the distribution. + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of the distribution, a positive number. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.NORM_DIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability corresponding to the normal distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - The arithmetic mean of the distribution. + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of the distribution, a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.NORMINV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability corresponding to the normal distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - The arithmetic mean of the distribution. + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of the distribution, a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.NORM_INV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the standard normal cumulative distribution (has a mean of zero and a standard deviation of one). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the distribution will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.NORMSDIST = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the standard normal distribution (has a mean of zero and a standard deviation of one). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {boolean} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which the distribution will be returned. + * @param {ApiRange | ApiName | boolean} arg2 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.NORM_S_DIST = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability corresponding to the normal distribution, a number between 0 and 1 inclusive. + * @returns {number} */ ApiWorksheetFunction.prototype.NORMSINV = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A probability corresponding to the normal distribution, a number between 0 and 1 inclusive. + * @returns {number} */ ApiWorksheetFunction.prototype.NORM_S_INV = function (arg1) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the Pearson product moment correlation coefficient, r. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is a set of independent values. +// * @param {any} arg2 Is a set of dependent values. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.PEARSON = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the k-th percentile of values in a range. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of data that defines relative standing. + * @param {ApiRange | ApiName | number} arg2 - The percentile value that is equal to 0 but less than or equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.PERCENTILE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of data that defines relative standing. + * @param {ApiRange | ApiName | number} arg2 - The percentile value that is greater than 0 but less than 1. + * @returns {number} */ ApiWorksheetFunction.prototype.PERCENTILE_EXC = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of data that defines relative standing. + * @param {ApiRange | ApiName | number} arg2 - The percentile value that is equal to 0 but less than or equal to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.PERCENTILE_INC = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the rank of a value in a data set as a percentage of the data set. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of data with numeric values that defines relative standing. + * @param {ApiRange | ApiName | number} arg2 - The value for which the rank will be returned. + * @param {ApiRange | ApiName | number} [arg3] - An optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%). + * @returns {number} */ ApiWorksheetFunction.prototype.PERCENTRANK = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of data with numeric values that defines relative standing. + * @param {ApiRange | ApiName | number} arg2 - The value for which the rank will be returned. + * @param {ApiRange | ApiName | number} [arg3] - An optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%). + * @returns {number} */ ApiWorksheetFunction.prototype.PERCENTRANK_EXC = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of data with numeric values that defines relative standing. + * @param {ApiRange | ApiName | number} arg2 - The value for which the rank will be returned. + * @param {ApiRange | ApiName | number} [arg3] - An optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%). + * @returns {number} */ ApiWorksheetFunction.prototype.PERCENTRANK_INC = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of permutations for a given number of objects that can be selected from the total objects. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The total number of objects. + * @param {ApiRange | ApiName | number} arg2 - The number of objects in each permutation. + * @returns {number} */ ApiWorksheetFunction.prototype.PERMUT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The total number of objects. + * @param {ApiRange | ApiName | number} arg2 - The number of objects in each permutation. + * @returns {number} */ ApiWorksheetFunction.prototype.PERMUTATIONA = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the value of the density function for a standard normal distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number for which the density of the standard normal distribution will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.PHI = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Poisson distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {boolean} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of events. + * @param {ApiRange | ApiName | number} arg2 - The expected numeric value, a positive number. + * @param {ApiRange | ApiName | boolean} arg3 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative Poisson probability. + * If it is false, the function returns the Poisson probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.POISSON = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Poisson distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {boolean} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of events. + * @param {ApiRange | ApiName | number} arg2 - The expected numeric value, a positive number. + * @param {ApiRange | ApiName | boolean} arg3 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative Poisson probability. + * If it is false, the function returns the Poisson probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.POISSON_DIST = function (arg1, arg2, arg3) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the probability that values in a range are between two limits or equal to a lower limit. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. -// * @param {number} arg3. -// * @param {number} [arg4]. +// * @param {any} arg1 Is the range of numeric values of x with which there are associated probabilities. +// * @param {any} arg2 Is the set of probabilities associated with values in X_range, values between 0 and 1 and excluding 0. +// * @param {ApiRange | ApiName | number} arg3 Is the lower bound on the value for which you want a probability. +// * @param {ApiRange | ApiName | number} [arg4] Is the optional upper bound on the value. If omitted, PROB returns the probability that X_range values are equal to Lower_limit. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.PROB = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the quartile of a data set. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or cell range of numeric values for which the quartile value will be returned. + * @param {ApiRange | ApiName | number} arg2 - The quartile value to return: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4. + * @returns {number} */ ApiWorksheetFunction.prototype.QUARTILE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the quartile of a data set, based on percentile values from 0..1, exclusive. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or cell range of numeric values for which the quartile value will be returned. + * @param {ApiRange | ApiName | number} arg2 - The quartile value to return: 1st quartile = 1; median value = 2; 3rd quartile = 3. + * @returns {number} */ ApiWorksheetFunction.prototype.QUARTILE_EXC = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the quartile of a data set, based on percentile values from 0..1, inclusive. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or cell range of numeric values for which the quartile value will be returned. + * @param {ApiRange | ApiName | number} arg2 - The quartile value to return: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4. + * @returns {number} */ ApiWorksheetFunction.prototype.QUARTILE_INC = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the rank of a number in a list of numbers: its size relative to other values in the list. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {ApiRange} arg2. - * @param {boolean} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number for which the rank will be returned. + * @param {ApiRange | ApiName | number[]} arg2 - An array or range of numbers. Nonnumeric values are ignored. + * @param {ApiRange | ApiName | boolean} [arg3] - The numeric value that specifyes how to order the numbers. If it is 0 or omitted, the rank in the list will be sorted in descending order. + * Any other numeric value means that the rank in the list will be sorted in ascending order. + * @returns {number} */ ApiWorksheetFunction.prototype.RANK = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the rank of a number in a list of numbers: its size relative to other values in the list. If more than one value has the same rank, the average rank is returned. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {ApiRange} arg2. - * @param {boolean} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number for which the rank will be returned. + * @param {ApiRange | ApiName | number[]} arg2 - An array or range of numbers. Nonnumeric values are ignored. + * @param {ApiRange | ApiName | boolean} [arg3] - The numeric value that specifyes how to order the numbers. If it is 0 or omitted, the rank in the list will be sorted in descending order. + * Any other numeric value means that the rank in the list will be sorted in ascending order. + * @returns {number} */ ApiWorksheetFunction.prototype.RANK_AVG = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the rank of a number in a list of numbers: its size relative to other values in the list. If more than one value has the same rank, the top rank of that set of values is returned. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {ApiRange} arg2. - * @param {boolean} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number for which the rank will be returned. + * @param {ApiRange | ApiName | number[]} arg2 - An array or range of numbers. Nonnumeric values are ignored. + * @param {ApiRange | ApiName | boolean} [arg3] - The numeric value that specifyes how to order the numbers. If it is 0 or omitted, the rank in the list will be sorted in descending order. + * Any other numeric value means that the rank in the list will be sorted in ascending order. + * @returns {number} */ ApiWorksheetFunction.prototype.RANK_EQ = function (arg1, arg2, arg3) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the square of the Pearson product moment correlation coefficient through the given data points. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is an array or range of data points and can be numbers or names, arrays, or references that contain numbers. +// * @param {any} arg2 Is an array or range of data points and can be numbers or names, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.RSQ = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | ApiName | number[] | ApiRange} args - Up to 255 numeric values for which the skewness of a distribution will be returned. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.SKEW = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | ApiName | number[] | ApiRange} args - Up to 255 numeric values for which the skewness of a distribution will be returned. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.SKEW_P = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the slope of the linear regression line through the given data points. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is an array or cell range of numeric dependent data points and can be numbers or names, arrays, or references that contain numbers. +// * @param {any} arg2 Is the set of independent data points and can be numbers or names, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.SLOPE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the k-th smallest value in a data set. For example, the fifth smallest number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - An array or range of numerical data for which the k-th smallest value will be determined. + * @param {ApiRange | ApiName | number} arg2 - The position (from the smallest) in the range of the value to return. + * @returns {number} */ ApiWorksheetFunction.prototype.SMALL = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a normalised value from a distribution characterised by a mean and standard deviation. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to normalize. + * @param {ApiRange | ApiName | number} arg2 - The arithmetic mean of the distribution. + * @param {ApiRange | ApiName | number} arg3 - The standard deviation of the distribution, a positive number. + * @returns {number} */ ApiWorksheetFunction.prototype.STANDARDIZE = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Estimates standard deviation based on a sample (ignores logical values and text in the sample). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number[] | number | ApiName | ApiRange} args - Up to 255 numeric values for which the standard deviation will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.STDEV = function () { return 0; }; /** - * Returns the result of calculating the function. + * Estimates standard deviation based on a sample (ignores logical values and text in the sample). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number[] | number | ApiName | ApiRange} args - Up to 255 numeric values for which the standard deviation will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.STDEV_S = function () { return 0; }; /** - * Returns the result of calculating the function. + * Estimates standard deviation based on a sample, including logical values and text. Text and the false logical value have the value 0; the true logical value has the value 1. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number[] | number | string | boolean | ApiRange | ApiName} args - Up to 255 values for which the standard deviation will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values, text strings, names, ranges, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.STDEVA = function () { return 0; }; /** - * Returns the result of calculating the function. + * Calculates standard deviation based on the entire population given as arguments (ignores logical values and text). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number[] | number | ApiName | ApiRange} args - Up to 255 numeric values for which the standard deviation will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.STDEVP = function () { return 0; }; /** - * Returns the result of calculating the function. + * Calculates standard deviation based on the entire population given as arguments (ignores logical values and text). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number[] | number | ApiName | ApiRange} args - Up to 255 numeric values for which the standard deviation will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.STDEV_P = function () { return 0; }; /** - * Returns the result of calculating the function. + * Calculates standard deviation based on the entire population, including logical values and text. + * Text and the false logical value have the value 0; the true logical value has the value 1. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number[] | number | string | boolean | ApiRange | ApiName} args - Up to 255 values for which the standard deviation will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values, text strings, names, ranges, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.STDEVPA = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the standard error of the predicted y-value for each x in a regression. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is an array or range of dependent data points and can be numbers or names, arrays, or references that contain numbers. +// * @param {any} arg2 Is an array or range of independent data points and can be numbers or names, arrays, or references that contain numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.STEYX = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Student's t-distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value at which to evaluate the distribution. + * @param {ApiRange | ApiName | number} arg2 - An integer indicating the number of degrees of freedom that characterize the distribution. + * @param {ApiRange | ApiName | number} arg3 - Specifies the number of distribution tails to return: one-tailed distribution = 1; two-tailed distribution = 2. + * @returns {number} */ ApiWorksheetFunction.prototype.TDIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the left-tailed Student's t-distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {boolean} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value at which to evaluate the distribution. + * @param {ApiRange | ApiName | number} arg2 - An integer indicating the number of degrees of freedom that characterize the distribution. + * @param {ApiRange | ApiName | boolean} arg3 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability density function. + * @returns {number} */ ApiWorksheetFunction.prototype.T_DIST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the two-tailed Student's t-distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value at which to evaluate the distribution. + * @param {ApiRange | ApiName | number} arg2 - An integer indicating the number of degrees of freedom that characterize the distribution. + * @returns {number} */ ApiWorksheetFunction.prototype.T_DIST_2T = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the right-tailed Student's t-distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value at which to evaluate the distribution. + * @param {ApiRange | ApiName | number} arg2 - An integer indicating the number of degrees of freedom that characterize the distribution. + * @returns {number} */ ApiWorksheetFunction.prototype.T_DIST_RT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the left-tailed inverse of the Student's t-distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - A positive integer indicating the number of degrees of freedom to characterize the distribution. + * @returns {number} */ ApiWorksheetFunction.prototype.T_INV = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the two-tailed inverse of the Student's t-distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - A positive integer indicating the number of degrees of freedom to characterize the distribution. + * @returns {number} */ ApiWorksheetFunction.prototype.T_INV_2T = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the two-tailed inverse of the Student's t-distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive. + * @param {ApiRange | ApiName | number} arg2 - A positive integer indicating the number of degrees of freedom to characterize the distribution. + * @returns {number} */ ApiWorksheetFunction.prototype.TINV = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns numbers in a linear trend matching known data points, using the least squares method. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {ApiRange} [arg2]. - * @param {ApiRange} [arg3]. - * @param {boolean} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - A range or array of y-values from the y = mx + b equation. + * @param {ApiRange | ApiName | number[]} [arg2] - An optional range or array of x-values from the y = mx + b equation, an array of the same size as an array of y-values. + * @param {ApiRange | ApiName | number[]} [arg3] - A range or array of new x-values for which this function will return corresponding y-values. + * @param {ApiRange | ApiName | boolean} [arg4] - A logical value: the constant b is calculated normally if this parameter is set to true or omitted, + * and b is set equal to 0 if the parameter is false. + * @returns {number} */ ApiWorksheetFunction.prototype.TREND = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the mean of the interior portion of a set of data values. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - The array or range of values to trim and average. + * @param {ApiRange | ApiName | number} arg2 - The fractional number of data points to exclude from the top and bottom of the data set. + * @returns {number} */ ApiWorksheetFunction.prototype.TRIMMEAN = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the probability associated with a Student's t-Test. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. -// * @param {number} arg3. -// * @param {number} arg4. +// * @param {any} arg1 Is the first data set. +// * @param {any} arg2 Is the second data set. +// * @param {ApiRange | ApiName | number} arg3 Specifies the number of distribution tails to return: one-tailed distribution = 1; two-tailed distribution = 2. +// * @param {ApiRange | ApiName | number} arg4 Is the kind of t-test: paired = 1, two-sample equal variance (homoscedastic) = 2, two-sample unequal variance = 3. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.TTEST = function (arg1, arg2, arg3, arg4) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the probability associated with a Student's t-Test. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. -// * @param {number} arg3. -// * @param {number} arg4. +// * @param {any} arg1 Is the first data set. +// * @param {any} arg2 Is the second data set. +// * @param {ApiRange | ApiName | number} arg3 Specifies the number of distribution tails to return: one-tailed distribution = 1; two-tailed distribution = 2. +// * @param {ApiRange | ApiName | number} arg4 Is the kind of t-test: paired = 1, two-sample equal variance (homoscedastic) = 2, two-sample unequal variance = 3. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.T_TEST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Estimates variance based on a sample (ignores logical values and text in the sample). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | ApiName | ApiRange | number[]} args - Up to 255 numeric values for which the variance will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.VAR = function () { return 0; }; /** - * Returns the result of calculating the function. + * Estimates variance based on a sample, including logical values and text. Text and the false logical value have the value 0; the true logical value has the value 1. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | string | boolean | Array | ApiRange | ApiName} args - Up to 255 values for which the variance will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values or text representations of numbers, names, ranges, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.VARA = function () { return 0; }; /** - * Returns the result of calculating the function. + * Calculates variance based on the entire population (ignores logical values and text in the population). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | ApiName | ApiRange | number[]} args - Up to 255 numeric values for which the variance will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.VARP = function () { return 0; }; /** - * Returns the result of calculating the function. + * Calculates variance based on the entire population (ignores logical values and text in the population). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | ApiName | ApiRange | number[]} args - Up to 255 numeric values for which the variance will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.VAR_P = function () { return 0; }; /** - * Returns the result of calculating the function. + * Estimates variance based on a sample (ignores logical values and text in the sample). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | ApiName | ApiRange | number[]} args - Up to 255 numeric values for which the variance will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, names, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.VAR_S = function () { return 0; }; /** - * Returns the result of calculating the function. + * Calculates variance based on the entire population, including logical values and text. Text and the false logical value have the value 0; the true logical value has the value 1. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | string | boolean | Array | ApiRange | ApiName} args - Up to 255 values for which the variance will be calculated. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values or text representations of numbers, names, ranges, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.VARPA = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Weibull distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.WEIBULL = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Weibull distribution. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function, a nonnegative number. + * @param {ApiRange | ApiName | number} arg2 - The alpha parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | number} arg3 - The beta parameter of the distribution, a positive number. + * @param {ApiRange | ApiName | boolean} arg4 - A logical value (true or false) that determines the function form. + * If it is true, the function returns the cumulative distribution function. + * If it is false, the function returns the probability mass function. + * @returns {number} */ ApiWorksheetFunction.prototype.WEIBULL_DIST = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the one-tailed P-value of a z-test. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {number[] | ApiRange | ApiName} arg1 - The array or range of data against which to test X. + * @param {ApiRange | ApiName | number} arg2 - The value to test. + * @param {ApiRange | ApiName | number} [arg3] - The population (known) standard deviation. If omitted, the sample standard deviation is used. + * @returns {number} */ ApiWorksheetFunction.prototype.ZTEST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the one-tailed P-value of a z-test. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {number[] | ApiRange} arg1 - The array or range of data against which to test X. + * @param {ApiRange | ApiName | number} arg2 - The value to test. + * @param {ApiRange | ApiName | number} [arg3] - The population (known) standard deviation. If omitted, the sample standard deviation is used. + * @returns {number} */ ApiWorksheetFunction.prototype.Z_TEST = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number that represents the date in the date-time code. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A number from 1900 or 1904 (depending on the workbook's date system) to 9999. + * @param {ApiRange | ApiName | number} arg2 - A number from 1 to 12 representing the month of the year. + * @param {ApiRange | ApiName | number} arg3 - A number from 1 to 31 representing the day of the month. + * @returns {number} */ ApiWorksheetFunction.prototype.DATE = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a date in the form of text to a number that represents the date in the date-time code. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The text that represents a date, between 1/1/1900 or 1/1/1904 (depending on the workbook's date system) and 12/31/9999. + * @returns {number} */ ApiWorksheetFunction.prototype.DATEVALUE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the day of the date given in the numerical format, a number from 1 to 31. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A number in the date-time code. + * @returns {number} */ ApiWorksheetFunction.prototype.DAY = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of days between the two dates. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Start date from which days will be counted. + * @param {ApiRange | ApiName | number} arg2 - End date until which days will be counted. + * @returns {number} */ ApiWorksheetFunction.prototype.DAYS = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of days between two dates based on a 360-day year (twelve 30-day months). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {boolean} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Start date from which days will be counted. + * @param {ApiRange | ApiName | number} arg2 - End date until which days will be counted. + * @param {ApiRange | ApiName | boolean} [arg3] - A logical value that specifies whether to use the U.S. (NASD) (false or omitted) or European (true) method in the calculation. + * According to the European method, the start and end dates that occur on the 31st of a month become equal to the 30th of the same month. + * According to the U.S. method, the start date is the last day of a month, it becomes equal to the 30th of the same month. + * If the end date is the last day of a month and the start date is earlier than the 30th of a month, the end date becomes equal to the 1st of the next month. + * Otherwise the end date becomes equal to the 30th of the same month. + * @returns {number} */ ApiWorksheetFunction.prototype.DAYS360 = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the serial number of the date which comes the indicated number of months before or after the start date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A serial date number that represents the start date. + * @param {ApiRange | ApiName | number} arg2 - The number of months before or after the start date. + * @returns {number} */ ApiWorksheetFunction.prototype.EDATE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the serial number of the last day of the month before or after the specified number of months. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A serial date number that represents the start date. + * @param {ApiRange | ApiName | number} arg2 - The number of months before or after the start date. + * @returns {number} */ ApiWorksheetFunction.prototype.EOMONTH = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string} arg1 - A number in the date-time code, or text in the time format, such as "16:48:00" or "4:48:00 PM", or a result of other formulas or functions. + * @returns {number} */ ApiWorksheetFunction.prototype.HOUR = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the ISO week number in the year for a given date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The date-time code used for date and time calculation. + * @returns {number} */ ApiWorksheetFunction.prototype.ISOWEEKNUM = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the minute, a number from 0 to 59. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string} arg1 - A number in the date-time code, or text in the time format, such as "16:48:00" or "4:48:00 PM", or a result of other formulas or functions. + * @returns {number} */ ApiWorksheetFunction.prototype.MINUTE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the month, a number from 1 (January) to 12 (December). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1- A number in the date-time code. + * @returns {number} */ ApiWorksheetFunction.prototype.MONTH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of whole workdays between two dates. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A serial date number that represents the start date. + * @param {ApiRange | ApiName | number} arg2 - A serial date number that represents the end date. + * @param {ApiRange | number[]} [arg3] - An optional range or array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + * @returns {number} */ ApiWorksheetFunction.prototype.NETWORKDAYS = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of whole workdays between two dates with custom weekend parameters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {number} [arg3]. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A serial date number that represents the start date. + * @param {ApiRange | ApiName | number} arg2 - A serial date number that represents the end date. + * @param {ApiRange | ApiName | number | string} [arg3] - A number or string specifying when weekends occur. + * @param {ApiRange | number[]} [arg4] - An optional range or array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + * @returns {number} */ ApiWorksheetFunction.prototype.NETWORKDAYS_INTL = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the current date and time in the MM/dd/yy hh:mm format. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @returns {number} */ ApiWorksheetFunction.prototype.NOW = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the second, a number from 0 to 59. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string} arg1 - A number in the date-time code, or text in the time format, such as "16:48:00" or "4:48:00 PM", or a result of other formulas or functions. + * @returns {number} */ ApiWorksheetFunction.prototype.SECOND = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts hours, minutes and seconds given as numbers to a serial number, formatted with the time format. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A number from 0 to 23 representing the hour. + * @param {ApiRange | ApiName | number} arg2 - A number from 0 to 59 representing the minute. + * @param {ApiRange | ApiName | number} arg3 - A number from 0 to 59 representing the second. + * @returns {number} */ ApiWorksheetFunction.prototype.TIME = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a text time to a serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - A text string that represents a time in one of the time formats (date information in the string is ignored). + * @returns {number} */ ApiWorksheetFunction.prototype.TIMEVALUE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the current date in the MM/dd/yy format. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @returns {number} */ ApiWorksheetFunction.prototype.TODAY = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number from 1 to 7 identifying the day of the week of the specified date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A number that represents a date, or a result of other formulas or functions. + * @param {ApiRange | ApiName | number} [arg2] - A number that determines the type of return value: 1 - returns a number from 1 (Sunday) to 7 (Saturday); + * 2 - returns a number from 1 (Monday) to 7 (Sunday); 3 - returns a number from 0 (Monday) to 6 (Sunday). + * @returns {number} */ ApiWorksheetFunction.prototype.WEEKDAY = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the week number in the year. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The date-time code used for date and time calculation. + * @param {ApiRange | ApiName | number} [arg2] - A number (1 or 2) that determines the type of the return value: Sunday (1) or Monday (2). + * @returns {number} */ ApiWorksheetFunction.prototype.WEEKNUM = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the serial number of the date before or after a specified number of workdays. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A serial date number that represents the start date. + * @param {ApiRange | ApiName | number} arg2 - The number of nonweekend and non-holiday days before or after the start date. A positive value for days yields a future date; a negative value yields a past date. + * @param {ApiRange | ApiName | number[]} [arg3] - An optional range or array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + * @returns {number} */ ApiWorksheetFunction.prototype.WORKDAY = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {number} [arg3]. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A serial date number that represents the start date. + * @param {ApiRange | ApiName | number} arg2 - The number of nonweekend and non-holiday days before or after the start date. A positive value for days yields a future date; a negative value yields a past date. + * @param {ApiRange | ApiName | number | string} [arg3] - A number or string specifying when weekends occur. + * @param {ApiRange | ApiName | number[]} [arg4] - An optional range or array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + * @returns {number} */ ApiWorksheetFunction.prototype.WORKDAY_INTL = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the year of a date, an integer in the range 1900-9999. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A number in the date-time code, or a result of other formulas or functions. + * @returns {number} */ ApiWorksheetFunction.prototype.YEAR = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the year fraction representing the number of whole days between the start date and end date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A serial date number that represents the start date. + * @param {ApiRange | ApiName | number} arg2 - A serial date number that represents the end date. + * @param {ApiRange | ApiName | number} [arg3] - The type of day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.YEARFRAC = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the modified Bessel function In(x). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function. + * @param {ApiRange | ApiName | number} arg2 - The order of the Bessel function. + * @returns {number} */ ApiWorksheetFunction.prototype.BESSELI = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Bessel function Jn(x). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function. + * @param {ApiRange | ApiName | number} arg2 - The order of the Bessel function. + * @returns {number} */ ApiWorksheetFunction.prototype.BESSELJ = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the modified Bessel function Kn(x). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function. + * @param {ApiRange | ApiName | number} arg2 - The order of the function. + * @returns {number} */ ApiWorksheetFunction.prototype.BESSELK = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the Bessel function Yn(x). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value at which to evaluate the function. + * @param {ApiRange | ApiName | number} arg2 - The order of the function. + * @returns {number} */ ApiWorksheetFunction.prototype.BESSELY = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a binary number to decimal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The binary number which will be convertrd. + * @returns {number} */ ApiWorksheetFunction.prototype.BIN2DEC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a binary number to hexadecimal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The binary number which will be convertrd. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.BIN2HEX = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a binary number to octal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The binary number which will be convertrd. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.BIN2OCT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a bitwise "AND" of two numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The first decimal representation of the binary number to evaluate. + * @param {ApiRange | ApiName | number} arg2 - The second decimal representation of the binary number to evaluate. + * @returns {number} */ ApiWorksheetFunction.prototype.BITAND = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number shifted left by the specified number of bits. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The decimal representation of the binary number to evaluate. + * @param {ApiRange | ApiName | number} arg2 - The number of bits by which the number will be shifted left. + * @returns {number} */ ApiWorksheetFunction.prototype.BITLSHIFT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a bitwise "OR" of two numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The first decimal representation of the binary number to evaluate. + * @param {ApiRange | ApiName | number} arg2 - The second decimal representation of the binary number to evaluate. + * @returns {number} */ ApiWorksheetFunction.prototype.BITOR = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number shifted right by the specified number of bits. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The decimal representation of the binary number to evaluate. + * @param {ApiRange | ApiName | number} arg2 - The number of bits by which the number will be shifted right. + * @returns {number} */ ApiWorksheetFunction.prototype.BITRSHIFT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a bitwise "XOR" (Exclusive Or) of two numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The first decimal representation of the binary number to evaluate. + * @param {ApiRange | ApiName | number} arg2 - The second decimal representation of the binary number to evaluate. + * @returns {number} */ ApiWorksheetFunction.prototype.BITXOR = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts real and imaginary coefficients into a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The real coefficient of the complex number. + * @param {ApiRange | ApiName | number} arg2 - The imaginary coefficient of the complex number. + * @param {ApiRange | ApiName | string} [arg3] - The suffix for the imaginary component of the complex number. It can be either "i" or "j" in lowercase. + * If it is omitted, the function will assume suffix to be "i". + * @returns {number} */ ApiWorksheetFunction.prototype.COMPLEX = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a number from one measurement system to another. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value in the specified units to be converted. + * @param {ApiRange | ApiName | string} arg2 - The original measurement unit. + * @param {ApiRange | ApiName | string} arg3 - The units for the result. + * @returns {number} */ ApiWorksheetFunction.prototype.CONVERT = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a decimal number to binary. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The decimal integer to convert. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.DEC2BIN = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a decimal number to hexadecimal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The decimal integer to convert. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.DEC2HEX = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a decimal number to octal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Te decimal integer to convert. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.DEC2OCT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Tests whether two numbers are equal. The function returns 1 if the numbers are equal and 0 otherwise. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The first number. + * @param {ApiRange | ApiName | number} [arg2] - The second number. + * @returns {number} */ ApiWorksheetFunction.prototype.DELTA = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the error function integrated between the specified lower and upper limits. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The lower bound for integrating the error function. + * @param {ApiRange | ApiName | number} [arg2] - The upper bound for integrating the error function. + * @returns {number} */ ApiWorksheetFunction.prototype.ERF = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the error function integrated between 0 and the specified lower limit. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The lower bound for integrating the error function. + * @returns {number} */ ApiWorksheetFunction.prototype.ERF_PRECISE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the complementary error function integrated between the specified lower limit and infinity. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The lower bound for integrating the complementary error function. + * @returns {number} */ ApiWorksheetFunction.prototype.ERFC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the complementary error function integrated between the specified lower limit and infinity. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The lower bound for integrating the complementary error function. + * @returns {number} */ ApiWorksheetFunction.prototype.ERFC_PRECISE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Tests whether a number is greater than a threshold value. The function returns 1 if the number is greater than or equal to the threshold value and 0 otherwise. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to test against step. + * @param {ApiRange | ApiName | number} [arg2] - The threshold value. + * @returns {number} */ ApiWorksheetFunction.prototype.GESTEP = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a hexadecimal number to binary. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The hexadecimal number to convert. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.HEX2BIN = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a hexadecimal number to decimal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The hexadecimal number to convert. + * @returns {number} */ ApiWorksheetFunction.prototype.HEX2DEC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a hexadecimal number to octal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The hexadecimal number to convert. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.HEX2OCT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the absolute value (modulus) of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMABS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the imaginary coefficient of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMAGINARY = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the argument Theta, an angle expressed in radians. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMARGUMENT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the complex conjugate of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMCONJUGATE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cosine of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMCOS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic cosine of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMCOSH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cotangent of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMCOT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cosecant of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMCSC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic cosecant of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMCSCH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the quotient of two complex numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The complex numerator or dividend in the x + yi or x + yj form. + * @param {ApiRange | ApiName | number} arg2 - The complex denominator or divisor in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMDIV = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the exponential of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMEXP = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the natural logarithm of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMLN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the base-10 logarithm of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMLOG10 = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the base-2 logarithm of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMLOG2 = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a complex number raised to an integer power. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @param {ApiRange | ApiName | number} arg2 - The power to which the complex number will be raised. + * @returns {number} */ ApiWorksheetFunction.prototype.IMPOWER = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the product of the specified complex numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} args - Up to 255 complex numbers expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMPRODUCT = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the real coefficient of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMREAL = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the secant of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMSEC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic secant of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMSECH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sine of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMSIN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic sine of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMSINH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the square root of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMSQRT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the difference of two complex numbers expressed in the x + yi or x + yj form. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The complex number from which to subtract the second number. + * @param {ApiRange | ApiName | number} arg2 - The complex number to subtract from the first number. + * @returns {number} */ ApiWorksheetFunction.prototype.IMSUB = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sum of the specified complex numbers. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} args - Up to 255 complex numbers expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMSUM = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the tangent of a complex number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A complex number expressed in the x + yi or x + yj form. + * @returns {number} */ ApiWorksheetFunction.prototype.IMTAN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts an octal number to binary. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The octal number to convert. + * @param {ApiRange | ApiName | number} [arg2] - The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.OCT2BIN = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts an octal number to decimal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The octal number to convert. + * @returns {number} */ ApiWorksheetFunction.prototype.OCT2DEC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts an octal number to hexadecimal. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The octal number to convert. + * @param {ApiRange | ApiName | number} [arg2] -The number of characters to use. + * @returns {number} */ ApiWorksheetFunction.prototype.OCT2HEX = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Averages the values in a field (column) of records in a list or database that match conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DAVERAGE = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DCOUNT = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Counts nonblank cells in the field (column) of records in the database that match the conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1- The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DCOUNTA = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Extracts from a database a single record that matches the conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DGET = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the largest number in the field (column) of records in the database that match the conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DMAX = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the smallest number in the field (column) of records in the database that match the conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DMIN = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Multiplies the values in the field (column) of records in the database that match the conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DPRODUCT = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Estimates the standard deviation based on a sample from the selected database entries. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DSTDEV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Calculates the standard deviation based on the entire population of the selected database entries. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DSTDEVP = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Adds the numbers in the field (column) of records in the database that match the conditions you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DSUM = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Estimates variance based on a sample from the selected database entries. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DVAR = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Calculates variance based on the entire population of the selected database entries. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {string} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells that makes up the list or database. A database is a list of related data. + * @param {ApiRange | ApiName | number | string} arg2 - The column which is used in the function. Either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param {ApiRange | ApiName} arg3 - The range of cells that contains the conditions you specify. The range includes at least one column label and at least one cell below the column label for a condition. + * @returns {number} */ ApiWorksheetFunction.prototype.DVARP = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the accrued interest for a security that pays periodic interest. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} [arg7]. - * @param {any} [arg8]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The issue date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The date when the first interest is paid, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg4 - The annual coupon rate of the security. + * @param {ApiRange | ApiName | number} arg5 - The par value of the security. + * @param {ApiRange | ApiName | number} arg6 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg7] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @param {ApiRange | ApiName | number} [arg8] - A logical value: true (1) or omitted returns the accrued interest from the issue date to the settlement date. + * false (0) returns the accrued interest from the first interest date to the settlement date. + * @returns {number} */ ApiWorksheetFunction.prototype.ACCRINT = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the accrued interest for a security that pays interest at maturity. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The issue date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The annual coupon rate of the security. + * @param {ApiRange | ApiName | number} arg4 - The par value of the security. + * @param {ApiRange | ApiName | number} [arg5] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.ACCRINTM = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the prorated linear depreciation of an asset for each accounting period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} [arg7]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The cost of the asset. + * @param {ApiRange | ApiName | number} arg2 - The date when asset is purchased. + * @param {ApiRange | ApiName | number} arg3 - The date when the first period ends. + * @param {ApiRange | ApiName | number} arg4 - The salvage value of the asset at the end of its lifetime. + * @param {ApiRange | ApiName | number} arg5 - The period for which the depreciation will be calculated. + * @param {ApiRange | ApiName | number} arg6 - The rate of depreciation. + * @param {ApiRange | ApiName | number} [arg7] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.AMORDEGRC = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the prorated linear depreciation of an asset for each accounting period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} [arg7]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The cost of the asset. + * @param {ApiRange | ApiName | number} arg2 - The date when asset is purchased. + * @param {ApiRange | ApiName | number} arg3 - The date when the first period ends. + * @param {ApiRange | ApiName | number} arg4 - The salvage value of the asset at the end of its lifetime. + * @param {ApiRange | ApiName | number} arg5 - The period for which the depreciation will be calculated. + * @param {ApiRange | ApiName | number} arg6 - The rate of depreciation. + * @param {ApiRange | ApiName | number} [arg7] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.AMORLINC = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of days from the beginning of the coupon period to the settlement date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg4] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.COUPDAYBS = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of days in the coupon period that contains the settlement date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg4] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.COUPDAYS = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of days from the settlement date to the next coupon date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg4] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.COUPDAYSNC = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the next coupon date after the settlement date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg4] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.COUPNCD = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of coupons payable between the settlement date and maturity date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg4] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.COUPNUM = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the previous coupon date before the settlement date. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg4] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.COUPPCD = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cumulative interest paid between two periods. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate for the investment. + * @param {ApiRange | ApiName | number} arg2 - The total number of payment periods. + * @param {ApiRange | ApiName | number} arg3 - A present value of the payments. + * @param {ApiRange | ApiName | number} arg4 - The first period included into the calculation. + * @param {ApiRange | ApiName | number} arg5 - The last period included into the calculation. + * @param {ApiRange | ApiName | number} arg6 - The timing of the payment. + * @returns {number} */ ApiWorksheetFunction.prototype.CUMIPMT = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cumulative principal paid on a loan between two periods. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate for the investment. + * @param {ApiRange | ApiName | number} arg2 - The total number of payment periods. + * @param {ApiRange | ApiName | number} arg3 - A present value of the payments. + * @param {ApiRange | ApiName | number} arg4 - The first period included into the calculation. + * @param {ApiRange | ApiName | number} arg5 - The last period included into the calculation. + * @param {ApiRange | ApiName | number} arg6 - The timing of the payment. + * @returns {number} */ ApiWorksheetFunction.prototype.CUMPRINC = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the depreciation of an asset for a specified period using the fixed-declining balance method. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The initial cost of the asset. + * @param {ApiRange | ApiName | number} arg2 - The salvage value of the asset at the end of its lifetime. + * @param {ApiRange | ApiName | number} arg3 - The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param {ApiRange | ApiName | number} arg4 - The period for which the depreciation will be calculated. Period must use the same units as the useful life of the asset. + * @param {ApiRange | ApiName | number} [arg5] - The number of months in the first year. If this parameter is omitted, it is assumed to be 12. + * @returns {number} */ ApiWorksheetFunction.prototype.DB = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The initial cost of the asset. + * @param {ApiRange | ApiName | number} arg2 - The salvage value of the asset at the end of its lifetime. + * @param {ApiRange | ApiName | number} arg3 - The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param {ApiRange | ApiName | number} arg4 - The period for which the depreciation will be calculated. Period must use the same units as the useful life of the asset. + * @param {ApiRange | ApiName | number} [arg5] - The rate at which the balance declines. If this parameter is omitted, it is assumed to be 2 (the double-declining balance method). + * @returns {number} */ ApiWorksheetFunction.prototype.DDB = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the discount rate for a security. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The purchase price of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg4 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} [arg5] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.DISC = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A number expressed as a fraction. + * @param {ApiRange | ApiName | number} arg2 - The integer to use in the denominator of the fraction. + * @returns {number} */ ApiWorksheetFunction.prototype.DOLLARDE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A decimal number. + * @param {ApiRange | ApiName | number} arg2 - The integer to use in the denominator of a fraction. + * @returns {number} */ ApiWorksheetFunction.prototype.DOLLARFR = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the annual duration of a security with periodic interest payments. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The annual coupon rate of the security. + * @param {ApiRange | ApiName | number} arg4 - The annual yield of the security. + * @param {ApiRange | ApiName | number} arg5 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg6] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.DURATION = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the effective annual interest rate. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The nominal interest rate. + * @param {ApiRange | ApiName | number} arg2 - The number of compounding periods per year. + * @returns {number} */ ApiWorksheetFunction.prototype.EFFECT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the future value of an investment based on periodic, constant payments and a constant interest rate. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param {ApiRange | ApiName | number} arg2 - The total number of payment periods in the investment. + * @param {ApiRange | ApiName | number} arg3 - The payment made each period; it cannot change over the life of the investment. + * @param {ApiRange | ApiName | number} [arg4] - The present value, or the lump-sum amount that a series of future payments is worth now. If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg5] - A value representing the timing of payment: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.FV = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the future value of an initial principal after applying a series of compound interest rates. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The present value of an investment. + * @param {number[] | ApiRange | ApiName} arg2 - An array of interest rates to apply. + * @returns {number} */ ApiWorksheetFunction.prototype.FVSCHEDULE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the interest rate for a fully invested security. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The amount invested in the security. + * @param {ApiRange | ApiName | number} arg4 - The amount to be received at maturity. + * @param {ApiRange | ApiName | number} [arg6] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.INTRATE = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @param {number} [arg5]. - * @param {number} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param {ApiRange | ApiName | number} arg2 - The period for which the interest will be returned. It must be in the range from 1 to the total number of payments. + * @param {ApiRange | ApiName | number} arg3 - The total number of payment periods in an investment. + * @param {ApiRange | ApiName | number} arg4 - The present value, or the lump-sum amount that a series of future payments is worth now. + * @param {ApiRange | ApiName | number} [arg5] - The future value, or a cash balance which will be attained after the last payment is made. If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg6] - A logical value representing the timing of payment: at the end of the period = 0 or omitted, at the beginning of the period = 1. + * @returns {number} */ ApiWorksheetFunction.prototype.IPMT = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the internal rate of return for a series of cash flows. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {number[] | ApiRange} arg1 - A range or array of cells that contain numbers for which the internal rate of return will be calculated. + * @param {ApiRange | ApiName | number} [arg2] - An estimate at what the internal rate of return will be. If it is omitted, the function will assume guess to be 0.1 (10 percent). + * @returns {number} */ ApiWorksheetFunction.prototype.IRR = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the interest paid during a specific period of an investment. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param {ApiRange | ApiName | number} arg2 - The period for which the interest will be retuned. It must be in the range from 1 to the total number of payments. + * @param {ApiRange | ApiName | number} arg3 - The total number of payment periods in an investment. + * @param {ApiRange | ApiName | number} arg4 - The present value, or the lump-sum amount that a series of future payments is worth now. + * @returns {number} */ ApiWorksheetFunction.prototype.ISPMT = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the modified Macauley duration of a security with an assumed par value of $100. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The annual coupon rate of the security. + * @param {ApiRange | ApiName | number} arg4 - The annual yield of the security. + * @param {ApiRange | ApiName | number} arg5 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg6] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.MDURATION = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - A range or array of cells that contain numbers that represent a series of payments (negative) and income (positive) at regular periods. + * @param {ApiRange | ApiName | number} arg2 - The interest rate paid on the money used in the cash flows. + * @param {ApiRange | ApiName | number} arg3 - The interest rate received on the cash reinvestment. + * @returns {number} */ ApiWorksheetFunction.prototype.MIRR = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the annual nominal interest rate. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The effective interest rate of the security. + * @param {ApiRange | ApiName | number} arg2 - The number of compounding periods per year. + * @returns {number} */ ApiWorksheetFunction.prototype.NOMINAL = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param {ApiRange | ApiName | number} arg2 - The payment made each period; it cannot change over the life of the investment. + * @param {ApiRange | ApiName | number} arg3 - Te present value, or the lump-sum amount that a series of future payments is worth now. + * @param {ApiRange | ApiName | number} [arg4] - The future value, or a cash balance which will be attained after the last payment is made. If omitted, zero is used. + * @param {ApiRange | ApiName | number} [arg5] - A logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.NPER = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The discount rate. + * @param {number | ApiRange | number[]} args - Up to 255 arguments representing future payments (negative values) and income (positive values). + * The first argument is required, the subsequent values are optional. Arguments can be numbers, ranges, arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.NPV = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the price per $100 face value of a security with an odd first period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} arg7. - * @param {any} arg8. - * @param {any} [arg9]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The issue date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg4 - The first coupon date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg5 - The interest rate of the security. + * @param {ApiRange | ApiName | number} arg6 - The annual yield of the security. + * @param {ApiRange | ApiName | number} arg7 - The redemption value of the security, per $100 face value. + * @param {ApiRange | ApiName | number} arg8 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg9] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.ODDFPRICE = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the yield of a security with an odd first period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} arg7. - * @param {any} arg8. - * @param {any} [arg9]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The issue date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg4 - The first coupon date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg5 - The interest rate of the security. + * @param {ApiRange | ApiName | number} arg6 - The purchase price of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg7 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg8 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg9] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.ODDFYIELD = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the price per $100 face value of a security with an odd last period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} arg7. - * @param {any} [arg8]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The last coupon date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg5 - The interest rate of the security. + * @param {ApiRange | ApiName | number} arg5 - The annual yield of the security. + * @param {ApiRange | ApiName | number} arg6 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg8 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg9] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.ODDLPRICE = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the yield of a security with an odd last period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} arg7. - * @param {any} [arg8]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The last coupon date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg5 - The interest rate of the security. + * @param {ApiRange | ApiName | number} arg6 - The purchase price of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg6 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg8 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg9] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.ODDLYIELD = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of periods required by an investment to reach a specified value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period. + * @param {ApiRange | ApiName | number} arg2 - The present value of the investment. + * @param {ApiRange | ApiName | number} arg3 - The desired future value of the investment. + * @returns {number} */ ApiWorksheetFunction.prototype.PDURATION = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Calculates the payment for a loan based on constant payments and a constant interest rate. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period for the loan. For example, use 6%/4 for quarterly payments at 6% APR. + * @param {ApiRange | ApiName | number} arg2 - The total number of payments for the loan. + * @param {ApiRange | ApiName | number} arg3 - The present value: the total amount that a series of future payments is worth now. + * @param {ApiRange | ApiName | number} [arg4] - The future value, or a cash balance which will be attained after the last payment is made. If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg5] - A logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.PMT = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @param {number} [arg5]. - * @param {number} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param {ApiRange | ApiName | number} arg2 - The period for which the principal payment will be returned. It must be in the range from 1 to to the total number of payment periods. + * @param {ApiRange | ApiName | number} arg3 - The total number of payment periods in an investment. + * @param {ApiRange | ApiName | number} arg4 - The present value: the total amount that a series of future payments is worth now. + * @param {ApiRange | ApiName | number} [arg5] - The future value, or cash balance which will be attained after the last payment is made. + * @param {ApiRange | ApiName | number} [arg6] - A logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.PPMT = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the price per $100 face value for a security that pays periodic interest. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} [arg7]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The annual coupon rate of the security. + * @param {ApiRange | ApiName | number} arg4 - The annual yield of the security. + * @param {ApiRange | ApiName | number} arg5 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg6 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg7] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.PRICE = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the price per $100 face value for a discounted security. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The discount rate of the security. + * @param {ApiRange | ApiName | number} arg4 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} [arg5] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.PRICEDISC = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the price per $100 face value for a security that pays interest at maturity. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The issue date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg4 - The security interest rate at the issue date. + * @param {ApiRange | ApiName | number} arg5 - The annual yield of the security. + * @param {ApiRange | ApiName | number} [arg6] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.PRICEMAT = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the present value of an investment: the total amount that a series of future payments is worth now. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param {ApiRange | ApiName | number} arg2 - The total number of payment periods in an investment. + * @param {ApiRange | ApiName | number} arg3 - The payment made each period and cannot change over the life of the investment. + * @param {ApiRange | ApiName | number} [arg4] - The future value, or a cash balance which will be attained after the last payment is made. If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg5] - A logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + * @returns {number} */ ApiWorksheetFunction.prototype.PV = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the interest rate per period for a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} [arg4]. - * @param {number} [arg5]. - * @param {number} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The total number of payment periods for the loan or investment. + * @param {ApiRange | ApiName | number} arg2 - The payment made each period and cannot change over the life of the loan or investment. + * @param {ApiRange | ApiName | number} arg3 - The present value: the total amount that a series of future payments is worth now. + * @param {ApiRange | ApiName | number} [arg4] - The future value, or a cash balance which will be attained after the last payment is made. If omitted, it is equal to 0. + * @param {ApiRange | ApiName | number} [arg5] - A logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + * @param {ApiRange | ApiName | number} [arg6] - An estimate at what the rate will be. If it is omitted, the function will assume guess to be 0.1 (10 percent). + * @returns {number} */ ApiWorksheetFunction.prototype.RATE = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the amount received at maturity for a fully invested security. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The security settlement date, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The amount invested in the security. + * @param {ApiRange | ApiName | number} arg4 - The security discount rate. + * @param {ApiRange | ApiName | number} [arg6] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.RECEIVED = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns an equivalent interest rate for the growth of an investment. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number of periods for the investment. + * @param {ApiRange | ApiName | number} arg2 - The present value of the investment. + * @param {ApiRange | ApiName | number} arg3 - The future value of the investment. + * @returns {number} */ ApiWorksheetFunction.prototype.RRI = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the straight-line depreciation of an asset for one period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The initial cost of the asset. + * @param {ApiRange | ApiName | number} arg2 - The salvage value of the asset at the end of its lifetime. + * @param {ApiRange | ApiName | number} arg3 - The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @returns {number} */ ApiWorksheetFunction.prototype.SLN = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sum-of-years' digits depreciation of an asset for a specified period. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The initial cost of the asset. + * @param {ApiRange | ApiName | number} arg2 - The salvage value of the asset at the end of its lifetime. + * @param {ApiRange | ApiName | number} arg3 - The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param {ApiRange | ApiName | number} arg4 - The period for which the depreciation will be calculated. It must use the same units as the useful life of the asset. + * @returns {number} */ ApiWorksheetFunction.prototype.SYD = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the bond-equivalent yield for a treasury bill. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The settlement date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The discount rate of the Treasury bill. + * @returns {number} */ ApiWorksheetFunction.prototype.TBILLEQ = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the price per $100 face value for a Treasury bill. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The settlement date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The discount rate of the Treasury bill. + * @returns {number} */ ApiWorksheetFunction.prototype.TBILLPRICE = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the yield for a Treasury bill. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The settlement date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The purchase price of the Treasury bill, per $100 par value. + * @returns {number} */ ApiWorksheetFunction.prototype.TBILLYIELD = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the depreciation of an asset for any specified period, including partial periods, using the double-declining balance method or some other method specified. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {number} arg4. - * @param {number} arg5. - * @param {number} [arg6]. - * @param {boolean} [arg7]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The initial cost of the asset. + * @param {ApiRange | ApiName | number} arg2 - The salvage value of the asset at the end of its lifetime. + * @param {ApiRange | ApiName | number} arg3 - The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param {ApiRange | ApiName | number} arg4 - The starting period for which the depreciation will be calculated, in the same units as the useful life of the asset. + * @param {ApiRange | ApiName | number} arg5 - The ending period for which the depreciation will be calculated, in the same units as the useful life of the asset. + * @param {ApiRange | ApiName | number} [arg6] - The rate at which the balance declines. If it is omitted, the function will assume it to be 2 + * @param {ApiRange | ApiName | boolean} [arg7] - Specifies whether to use straight-line depreciation when depreciation is greater than the declining balance calculation (false or omitted). + * If it is set to true, the function uses the declining balance method. + * @returns {number} */ ApiWorksheetFunction.prototype.VDB = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the internal rate of return for a schedule of cash flows. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - A range that contains the series of cash flows that corresponds to a schedule of payments in dates. + * @param {ApiRange | ApiName} arg2 - A range that contains the schedule of payment dates that corresponds to the cash flow payments. + * @param {ApiRange | ApiName | number} [arg3] - An estimate at what the internal rate of return will be. If it is omitted, the function will assume guess to be 0.1 (10 percent). + * @returns {number} */ ApiWorksheetFunction.prototype.XIRR = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the net present value for a schedule of cash flows. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The discount rate to apply to the cash flows. + * @param {ApiRange | ApiName} arg2 - A range that contains the series of cash flows that corresponds to a schedule of payments in dates. + * @param {ApiRange | ApiName} arg3 - A range that contains the schedule of payment dates that corresponds to the cash flow payments. + * @returns {number} */ ApiWorksheetFunction.prototype.XNPV = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the yield on a security that pays periodic interest. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} arg6. - * @param {any} [arg7]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The settlement date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The annual coupon rate of the security. + * @param {ApiRange | ApiName | number} arg4 - The purchase price of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg5 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg6 - The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. + * @param {ApiRange | ApiName | number} [arg7] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.YIELD = function (arg1, arg2, arg3, arg4, arg5, arg6, arg7) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the annual yield for a discounted security. For example, a Treasury bill. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} [arg5]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The settlement date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The purchase price of the security, per $100 par value. + * @param {ApiRange | ApiName | number} arg4 - The redemption value of the security, per $100 par value. + * @param {ApiRange | ApiName | number} [arg5] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.YIELDDISC = function (arg1, arg2, arg3, arg4, arg5) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the annual yield of a security that pays interest at maturity. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @param {any} arg5. - * @param {any} [arg6]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The settlement date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg2 - The maturity date of the Treasury bill, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg3 - The issue date of the security, expressed as a serial date number. + * @param {ApiRange | ApiName | number} arg4 - The interest rate of the security at the issue date. + * @param {ApiRange | ApiName | number} arg5 - The purchase price of the security, per $100 par value. + * @param {ApiRange | ApiName | number} [arg6] - The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. + * @returns {number} */ ApiWorksheetFunction.prototype.YIELDMAT = function (arg1, arg2, arg3, arg4, arg5, arg6) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the absolute value of a number, a number without its sign. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The real number for which the absolute value will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.ABS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the arccosine of a number, in radians in the range from 0 to Pi. The arccosine is the angle whose cosine is a number specified in the parameters. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle cosine. It must be from -1 to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.ACOS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse hyperbolic cosine of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number equal to or greater than 1. + * @returns {number} */ ApiWorksheetFunction.prototype.ACOSH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the arccotangent of a number, in radians in the range from 0 to Pi. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle cotangent. + * @returns {number} */ ApiWorksheetFunction.prototype.ACOT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse hyperbolic cotangent of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle hyperbolic cotangent. It must be less than -1 or greater than 1. + * @returns {number} */ ApiWorksheetFunction.prototype.ACOTH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns an aggregate in a list or database. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A numeric value that specifies which function to use: 1 - AVERAGE, 2 - COUNT, 3 - COUNTA, 4 - MAX, 5 - MIN, + * 6 - PRODUCT, 7 - STDEV.S, 8 - STDEV.P, 9 - SUM, 10 - VAR.S, 11 - VAR.P, 12 - MEDIAN, 13 - MODE.SNGL, 14 - LARGE, + * 15 - SMALL, 16 - PERCENTILE.INC, 17 - QUARTILE.INC, 18 - PERCENTILE.EXC, 19 - QUARTILE.EXC. + * @param {ApiRange | ApiName | number} arg2 - A numeric value that specifies which values should be ignored: 0 or omitted - nested SUBTOTAL and AGGREGATE functions, + * 1 - hidden rows, nested SUBTOTAL and AGGREGATE functions, 2 - error values, nested SUBTOTAL and AGGREGATE functions, + * 3 - hidden rows, error values, nested SUBTOTAL and AGGREGATE functions, 4 - nothing, 5 - hidden rows, 6 - error values, 7 - hidden rows and error values. + * @param {number | ApiRange | number[]} arg3 - The first numeric value for which the aggregate value will be returned. + * @param {number | ApiRange | number[]} args - Up to 253 numeric values or a range of cells containing the values for which the aggregate value will be returned. + * Arguments can be numbers, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.AGGREGATE = function () { return 0; }; /** - * Returns the result of calculating the function. + * Converts a Roman numeral to Arabic. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The Roman numeral to convert. + * @returns {number} */ ApiWorksheetFunction.prototype.ARABIC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the arcsine of a number in radians, in the range from -Pi/2 to Pi/2. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle sine. It must be from -1 to 1. + * @returns {number} */ ApiWorksheetFunction.prototype.ASIN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse hyperbolic sine of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number equal to or greater than 1. + * @returns {number} */ ApiWorksheetFunction.prototype.ASINH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the arctangent of a number in radians, in the range from -Pi/2 to Pi/2. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle tangent. + * @returns {number} */ ApiWorksheetFunction.prototype.ATAN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the arctangent of the specified x and y coordinates, in radians between -Pi and Pi, excluding -Pi. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The x coordinate of the point. + * @param {ApiRange | ApiName | number} arg2 - The y coordinate of the point. + * @returns {number} */ ApiWorksheetFunction.prototype.ATAN2 = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the inverse hyperbolic tangent of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number between -1 and 1 excluding -1 and 1. + * @returns {number} */ ApiWorksheetFunction.prototype.ATANH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a number into a text representation with the given radix (base). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number to convert. + * @param {ApiRange | ApiName | number} arg2 - The base radix into which the number will be converted. An integer greater than or equal to 2 and less than or equal to 36. + * @param {ApiRange | ApiName | number} [arg3] - The minimum length of the returned string. An integer greater than or equal to 0 and less than 256. If omitted, leading zeros are not added to the result. + * @returns {number} */ ApiWorksheetFunction.prototype.BASE = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number up, to the nearest multiple of significance. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to round up. + * @param {ApiRange | ApiName | number} arg2 - The multiple of significance to round up to. + * @returns {number} */ ApiWorksheetFunction.prototype.CEILING = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number up, to the nearest integer or to the nearest multiple of significance. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to round up. + * @param {ApiRange | ApiName | number} [arg2] - The multiple of significance to round up to. If it is omitted, the default value of 1 is used. + * @param {ApiRange | ApiName | number} [arg3] - Specifies if negative numbers are rounded towards or away from zero. If it is omitted or set to 0, negative numbers are rounded towards zero. + * If any other numeric value is specified, negative numbers are rounded away from zero. + * @returns {number} */ ApiWorksheetFunction.prototype.CEILING_MATH = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number that is rounded up to the nearest integer or to the nearest multiple of significance. The number is always rounded up regardless of its sing. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to round up. + * @param {ApiRange | ApiName | number} [arg2] - The multiple of significance to round up to. If it is omitted, the default value of 1 is used. If it is set to zero, the function returns 0. + * @returns {number} */ ApiWorksheetFunction.prototype.CEILING_PRECISE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of combinations for a given number of items. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The total number of items, a numeric value greater than or equal to 0. + * @param {ApiRange | ApiName | number} arg2 - The number of items in each combination, a numeric value greater than or equal to 0 but less than the total number of items. + * @returns {number} */ ApiWorksheetFunction.prototype.COMBIN = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of combinations with repetitions for a given number of items. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The total number of items, a numeric value greater than or equal to 0. + * @param {ApiRange | ApiName | number} arg2 - The number of items in each combination, a numeric value greater than or equal to 0 but less than the total number of items. + * @returns {number} */ ApiWorksheetFunction.prototype.COMBINA = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cosine of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the cosine will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.COS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic cosine of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number for which the hyperbolic cosine will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.COSH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cotangent of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the cotangent will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.COT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic cotangent of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the hyperbolic cotangent will be calculated. Its absolute value must be less than 2^27. + * @returns {number} */ ApiWorksheetFunction.prototype.COTH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the cosecant of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the cosecant will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.CSC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic cosecant of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the hyperbolic cosecant will be calculated. Its absolute value must be less than 2^27. + * @returns {number} */ ApiWorksheetFunction.prototype.CSCH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a text representation of a number in a given base into a decimal number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string} arg1 - The number to convert. The string lenght must be less than or equal to 255 characters. + * @param {ApiRange | ApiName | number} arg2 - The base Radix of the number that is converting. An integer greater than or equal to 2 and less than or equal to 36. + * @returns {number} */ ApiWorksheetFunction.prototype.DECIMAL = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts radians to degrees. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians to convert. + * @returns {number} */ ApiWorksheetFunction.prototype.DEGREES = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds the number up to the nearest multiple of significance. Negative numbers are rounded towards zero. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to round up. + * @param {ApiRange | ApiName | number} arg2 - The multiple of significance to round up to. + * @returns {number} */ ApiWorksheetFunction.prototype.ECMA_CEILING = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a positive number up and negative number down to the nearest even integer. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to round up. + * @returns {number} */ ApiWorksheetFunction.prototype.EVEN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the e constant raised to the power of a given number. The e constant is equal to 2.71828182845904, the base of the natural logarithm. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The exponent applied to the base e. + * @returns {number} */ ApiWorksheetFunction.prototype.EXP = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the factorial of a number, which is equal to 1*2*3*...* number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The nonnegative number for which the factorial will be calculated. + * @returns {number} */ ApiWorksheetFunction.prototype.FACT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the double factorial of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value for which to return the double factorial. + * @returns {number} */ ApiWorksheetFunction.prototype.FACTDOUBLE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number down to the nearest multiple of significance. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value to round down. + * @param {ApiRange | ApiName | number} arg2 - The multiple of significance to round down to. The number to round down and the multiple of significance must have the same sign. + * @returns {number} */ ApiWorksheetFunction.prototype.FLOOR = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number that is rounded down to the nearest integer or to the nearest multiple of significance. The number is always rounded down regardless of its sign. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value to round down. + * @param {ApiRange | ApiName | number} [arg2] - The multiple of significance to round down to. If it is omitted, the default value of 1 is used. If it is set to zero, the function returns 0. + * @returns {number} */ ApiWorksheetFunction.prototype.FLOOR_PRECISE = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number down, to the nearest integer or to the nearest multiple of significance. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value to round down. + * @param {ApiRange | ApiName | number} [arg2] - The multiple of significance to round down to. If it is omitted, the default value of 1 is used. + * @param {ApiRange | ApiName | number} [arg3] - Specifies if negative numbers are rounded towards or away from zero. If it is omitted or set to 0, negative numbers are rounded away from zero. + * If any other numeric value is specified, negative numbers are rounded towards zero. + * @returns {number} */ ApiWorksheetFunction.prototype.FLOOR_MATH = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the greatest common divisor. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} args - Up to 255 numeric values for which the greatest common divisor will be returned. The first argument is required, subsequent arguments are optional. + * @returns {number} */ ApiWorksheetFunction.prototype.GCD = function () { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number down to the nearest integer. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The real number to round down to an integer. + * @returns {number} */ ApiWorksheetFunction.prototype.INT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number that is rounded up to the nearest integer or to the nearest multiple of significance regardless of the sign of the number. + * The number is always rounded up regardless of its sing. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The numeric value to round up. + * @param {ApiRange | ApiName | number} [arg2] - The multiple of significance to round up to. If it is omitted, the default value of 1 is used. If it is set to zero, the function returns 0. + * @returns {number} */ ApiWorksheetFunction.prototype.ISO_CEILING = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the least common multiple. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} args - Up to 255 numeric values for which the least common multiple will be returned. The first argument is required, subsequent arguments are optional. + * @returns {number} */ ApiWorksheetFunction.prototype.LCM = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the natural logarithm of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The positive real number for which the natural logarithm will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.LN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the logarithm of a number to the specified base. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The positive real number for which the logarithm will be returned. + * @param {ApiRange | ApiName | number} [arg2] - The logarithm base. If omitted, it is equal to 10. + * @returns {number} */ ApiWorksheetFunction.prototype.LOG = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the base-10 logarithm of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The positive real number for which the base-10 logarithm will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.LOG10 = function (arg1) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the matrix determinant of an array. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. +// * @param {any} arg1 Is a numeric array with an equal number of rows and columns, either a cell range or an array constant. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.MDETERM = function (arg1) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the inverse matrix for the matrix stored in an array. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. +// * @param {any} arg1 Is a numeric array with an equal number of rows and columns, either a cell range or an array constant. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.MINVERSE = function (arg1) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the matrix product of two arrays, an array with the same number of rows as array1 and columns as array2. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. +// * @param {any} arg1 Is the first array of numbers to multiply and must have the same number of columns as Array2 has rows. // * @param {any} arg2. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.MMULT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the remainder after a number is divided by a divisor. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number to divide and find the remainder. + * @param {ApiRange | ApiName | number} arg2 - The number to divide by. + * @returns {number} */ ApiWorksheetFunction.prototype.MOD = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a number rounded to the desired multiple. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to round. + * @param {ApiRange | ApiName | number} arg2 - The multiple to round the number to. + * @returns {number} */ ApiWorksheetFunction.prototype.MROUND = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the ratio of the factorial of a sum of numbers to the product of factorials. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} args - Up to 255 numeric values for which the multinomial will be returned. The first argument is required, subsequent arguments are optional. + * @returns {number} */ ApiWorksheetFunction.prototype.MULTINOMIAL = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the unit matrix for the specified dimension. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - An integer specifying the dimension of the unit matrix to be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.MUNIT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a positive number up and negative number down to the nearest odd integer. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to round. + * @returns {number} */ ApiWorksheetFunction.prototype.ODD = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the mathematical constant pi, equal to 3.14159265358979, accurate to 15 digits. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @returns {number} */ ApiWorksheetFunction.prototype.PI = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the result of a number raised to a power. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The base number. It can be any real number. + * @param {ApiRange | ApiName | number} arg2 - The exponent to which the base number is raised. + * @returns {number} */ ApiWorksheetFunction.prototype.POWER = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Multiplies all the numbers given as arguments. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | ApiRange | number[]} args - Up to 255 numeric values that will be multiplied. The first argument is required, subsequent arguments are optional. + * Arguments can be numbers, ranges, or arrays of numbers. + * @returns {number} */ ApiWorksheetFunction.prototype.PRODUCT = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the integer portion of a division. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The dividend, a numeric value. + * @param {ApiRange | ApiName | number} arg2 - The divisor, a numeric value. + * @returns {number} */ ApiWorksheetFunction.prototype.QUOTIENT = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts degrees to radians. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - An angle in degrees to convert. + * @returns {number} */ ApiWorksheetFunction.prototype.RADIANS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @returns {number} */ ApiWorksheetFunction.prototype.RAND = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns a random number between the numbers specified. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The smallest integer value. + * @param {ApiRange | ApiName | number} arg2 - The largest integer value. + * @returns {number} */ ApiWorksheetFunction.prototype.RANDBETWEEN = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Converts an arabic numeral to a roman numeral in the string format. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A numeric value greater than or equal to 1 and less than 3999. + * @param {ApiRange | ApiName | number} [arg2] - A roman numeral type: 0 - classic, 1 - more concise, 2 - more concise, 3 - more concise, 4 - simplified. + * @returns {string} */ -ApiWorksheetFunction.prototype.ROMAN = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.ROMAN = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Rounds a number to a specified number of digits. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number to round. + * @param {ApiRange | ApiName | number} arg2 - The number of digits to round to. If this argument is negative, the number will be rounded to the left of the decimal point. + * If it is equal to zero, the number will be rounded to the nearest integer. + * @returns {number} */ ApiWorksheetFunction.prototype.ROUND = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number down, toward zero. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number that will be rounded down. + * @param {ApiRange | ApiName | number} arg2 - The number of digits to round to. If this argument is negative, the number will be rounded to the left of the decimal point. + * If it is equal to zero, the number will be rounded to the nearest integer. + * @returns {number} */ ApiWorksheetFunction.prototype.ROUNDDOWN = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Rounds a number up, away from zero. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} arg2. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number that will be rounded up. + * @param {ApiRange | ApiName | number} arg2 - The number of digits to round to. If this argument is negative, the number will be rounded to the left of the decimal point. + * If it is equal to zero, the number will be rounded to the nearest integer. + * @returns {number} */ ApiWorksheetFunction.prototype.ROUNDUP = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the secant of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the secant will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.SEC = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic secant of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the hyperbolic secant will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.SECH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sum of a power series based on the formula. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. - * @param {any} arg3. - * @param {any} arg4. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The input value to the power series. + * @param {ApiRange | ApiName | number} arg2 - The initial power to which x will be raised. + * @param {ApiRange | ApiName | number} arg3 - The step by which to increase n for each term in the series. + * @param {ApiRange | ApiName | number} arg4 - A set of coefficients by which each successive power of x is multiplied. + * @returns {number} */ ApiWorksheetFunction.prototype.SERIESSUM = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sign of a number: 1 if the number is positive, 0 if the number is zero, or -1 if the number is negative. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number. + * @returns {number} */ ApiWorksheetFunction.prototype.SIGN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sine of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the sine will be returned. If your argument is in degrees, multiply it by PI()/180. + * @returns {number} */ ApiWorksheetFunction.prototype.SIN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic sine of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number for which the hyperbolic sine will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.SINH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the square root of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number for which the square root will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.SQRT = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the square root of (number * pi). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number by which pi is multiplied. + * @returns {number} */ ApiWorksheetFunction.prototype.SQRTPI = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns a subtotal in a list or database. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - A numeric value that specifies which function to use for the subtotal: 1 (101) - AVERAGE, 2 (102) - COUNT, + * 3 (103) - COUNTA, 4 (104) - MAX, 5 (105) - MIN, + * 6 (106) - PRODUCT, 7 (107) - STDEV, 8 (108) - STDEVP, 9 (109) - SUM, 10 (110) - VAR, 11 (111) - VARP. + * 1-11 includes manually-hidden rows, while 101-111 excludes them; + * filtered-out cells are always excluded. + * @param {ApiRange | ApiName} args - Up to 255 ranges containing the values for which the subtotal will be returned. The first argument is required, subsequent arguments are optional. + * @returns {number} */ ApiWorksheetFunction.prototype.SUBTOTAL = function () { return 0; }; /** - * Returns the result of calculating the function. + * Adds all the numbers in a range of cells. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | string | number | boolean | Array} args - Up to 255 numeric values to add. The first argument is required, subsequent arguments are optional. + * Arguments can be numbers, logical values, text representations of numbers, ranges, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.SUM = function () { return 0; }; /** - * Returns the result of calculating the function. + * Adds the cells specified by a given condition or criteria. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {any} arg2. - * @param {ApiRange} [arg3]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells to be evaluated. + * @param {ApiRange | ApiName | number | string} arg2 - The condition or criteria in the form of a number, expression, or text that defines which cells will be added. + * @param {ApiRange | ApiName} [arg3] - The range to sum. If omitted, the cells in range are used. + * @returns {number} */ ApiWorksheetFunction.prototype.SUMIF = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Adds the cells specified by a given set of conditions or criteria. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - The range of cells to be evaluated. + * @param {ApiRange | ApiName | number | string} arg2 - The first condition or criteria in the form of a number, expression, or text that defines which cells will be added. + * @param {ApiRange | ApiName} [arg3] - The first range to sum. If omitted, the cells in range are used. + * @param {ApiRange | ApiName | number | string} arg4 - Up to 127 additional conditions or criteria in the form of a number, expression, or text that defines which cells will be added. + * These arguments are optional. + * @param {ApiRange | ApiName} [arg5] - Up to 127 actual ranges to be used to be added. If omitted, the cells in the range are used. These arguments are optional. + * @returns {number} */ ApiWorksheetFunction.prototype.SUMIFS = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the sum of the products of corresponding ranges or arrays. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.SUMPRODUCT = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the sum of the squares of the arguments. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string | boolean | Array} args - Up to 255 numeric values for which the sum of the squares will be calculated. + * The first argument is required, subsequent arguments are optional. + * The arguments can be numbers, names, logical values or text representations of numbers, ranges of cells that contain numbers, or arrays. + * @returns {number} */ ApiWorksheetFunction.prototype.SUMSQ = function () { return 0; }; /** -// * Returns the result of calculating the function. +// * Sums the differences between the squares of two corresponding ranges or arrays. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first range or array of numbers and can be a number or name, array, or reference that contains numbers. +// * @param {any} arg2 Is the second range or array of numbers and can be a number or name, array, or reference that contains numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.SUMX2MY2 = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. +// * Returns the sum total of the sums of squares of numbers in two corresponding ranges or arrays. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first range or array of numbers and can be a number or name, array, or reference that contains numbers. +// * @param {any} arg2 Is the second range or array of numbers and can be a number or name, array, or reference that contains numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.SUMX2PY2 = function (arg1, arg2) { return 0; }; /** -// * Returns the result of calculating the function. +// * Sums the squares of the differences in two corresponding ranges or arrays. // * @memberof ApiWorksheetFunction -// * @typeofeditors ["CSE"] -// * @param {any} arg1. -// * @param {any} arg2. +// * @param {any} arg1 Is the first range or array of values and can be a number or name, array, or reference that contains numbers. +// * @param {any} arg2 Is the second range or array of values and can be a number or name, array, or reference that contains numbers. // * @returns {number | string | boolean} // */ // ApiWorksheetFunction.prototype.SUMXMY2 = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the tangent of an angle. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The angle in radians for which the tangent will be returned. If the argument is in degrees, multiply it by PI()/180. + * @returns {number} */ ApiWorksheetFunction.prototype.TAN = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the hyperbolic tangent of a number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - Any real number for which the hyperbolic tangent will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.TANH = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Truncates a number to an integer by removing the decimal, or fractional, part of the number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {number} arg1. - * @param {number} [arg2]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The number which will be truncated. + * @param {ApiRange | ApiName | number} [arg2] - A number specifying the precision of the truncation. If this argument is omitted, it is equal to 0 (zero). + * @returns {number} */ ApiWorksheetFunction.prototype.TRUNC = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Chooses a value or action to perform from a list of values, based on an index number. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The position of the value in the list of values, a numeric value greater than or equal to 1 but less than the number of values in the list of values. + * @param {number | string | ApiRange | ApiName} args - Up to 254 values or the selected range of cells to analyze. + * The first argument is required, subsequent arguments are optional. Arguments can be numbers, ranges, names, or text strings. + * @returns {number} */ ApiWorksheetFunction.prototype.CHOOSE = function () { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of columns in the cell range. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - A range or array of cells for which the number of columns will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.COLUMNS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Looks for a value in the top row of a table or array of values and returns the value in the same column from the specified row. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} [arg4]. - * @returns {number | string | boolean} + * @param {number | string | ApiRange | ApiName} arg1 - The value to be found in the first row of the table and can be a value, a reference, or a text string. + * @param {ApiRange | ApiName} arg2 - A table of text, numbers, or logical values in which data is looked up. The data is sorted in ascending order. + * This argument can be a range of cells or a range name. + * @param {ApiRange | ApiName | number} arg3 - The row number in data table from which the matching value should be returned. The first row of values in the table is row 1. + * @param {ApiRange | ApiName | boolean} [arg4] - A logical value which specifies whether to find the closest match in the top row (sorted in ascending order) (true or omitted) + * or find an exact match (false). + * @returns {number | string} */ ApiWorksheetFunction.prototype.HLOOKUP = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Creates a shortcut that jumps to another location in the current workbook, or opens a document stored on your hard drive, a network server, or on the Internet. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} arg1. - * @param {any} [arg2]. - * @returns {number | string | boolean} + * @param {string | ApiRange | ApiName} arg1 - The text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path. + * @param {string | ApiRange | number | ApiName} [arg2] - Text or a number that is displayed in the cell. If omitted, the cell displays the link location text. + * @returns {string} */ -ApiWorksheetFunction.prototype.HYPERLINK = function (arg1, arg2) { return 0; }; +ApiWorksheetFunction.prototype.HYPERLINK = function (arg1, arg2) { return ""; }; /** - * Returns the result of calculating the function. + * Returns a value or reference of the cell at the intersection of a particular row and column, in a given range. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @param {any} [arg4]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number[]} arg1 - A range of cells or an array constant. + * @param {ApiRange | ApiName | number} arg2 - The row in the range from which to return a value. If omitted, the column number is required. + * @param {ApiRange | ApiName | number} [arg3] - The column in the range from which to return a value. If omitted, the row number is required. + * @param {ApiRange | ApiName | number} [arg4] - An area to use in case the range contains several ranges. If it is omitted, the function will assume argument to be 1. + * @returns {number | string} */ ApiWorksheetFunction.prototype.INDEX = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * Looks up a value either from a one-row or one-column range. Provided for backwards compatibility. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {ApiRange} arg2. - * @param {ApiRange} [arg3]. + * @param {number | string | boolean | ApiRange | ApiName} arg1 - A value that is searched for in the first vector. It can be a number, text, a logical value, or a name or reference to a value. + * @param {ApiRange | ApiName} arg2 - A range that contains only one row or one column of text, numbers, or logical values, placed in ascending order. + * @param {ApiRange | ApiName} [arg3] - A range that contains only one row or column. It must be the same size as the first vector. * @returns {number | string | boolean} */ ApiWorksheetFunction.prototype.LOOKUP = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * The match type. + * * -1 - The values must be sorted in descending order. If the exact match is not found, the function will return the smallest value that is greater than the searched value. + * * 0 - The values can be sorted in any order. If the exact match is not found, the function will return the #N/A error. + * * 1 (or omitted) - The values must be sorted in ascending order. If the exact match is not found, the function will return the largest value that is less than the searched value. + * @typedef {("-1" | "0" | "1")} MatchType + * */ + +/** + * Returns the relative position of an item in a range that matches the specified value in the specified order. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {number} arg2. - * @param {number} [arg3]. - * @returns {number | string | boolean} + * @param {number | string | boolean | ApiRange | ApiName} arg1 - The value to be matched in the range. It can be a number, text, or logical value, or a reference to one of these. + * @param {ApiRange | ApiName | Array} arg2 - A contiguous range of cells or an array containing possible lookup values. + * @param {ApiRange | ApiName | number} [arg3] - A number 1, 0, or -1 indicating which value to return. + * @returns {number} */ ApiWorksheetFunction.prototype.MATCH = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of rows in a range. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | Array} arg1 - A range of cells or an array for which the number of rows will be returned. + * @returns {number} */ ApiWorksheetFunction.prototype.ROWS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Converts a vertical range of cells to a horizontal range, or vice versa. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | Array} arg1 - A range of cells on a worksheet or an array that will be transposed. + * @returns {ApiRange} */ -ApiWorksheetFunction.prototype.TRANSPOSE = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.TRANSPOSE = function (arg1) { return new ApiRange(); }; /** - * Returns the result of calculating the function. + * Looks for a value in the leftmost column of a table and then returns a value in the same row from the specified column. By default, the table must be sorted in an ascending order. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {number} arg2. - * @param {number} arg3. - * @param {boolean} [arg4]. - * @returns {number | string | boolean} + * @param {number | string | ApiRange | ApiName} arg1 - The value to be found in the first column of the table. It can be a value, a reference, or a text string. + * @param {ApiRange | ApiName} arg2 - A table of text, numbers, or logical values, in which data is retrieved. It can be a range of cells. + * @param {ApiRange | ApiName | number} arg3 - The column number in the data table from which the matching value should be returned. The first column of values in the table is column 1. + * @param {ApiRange | ApiName | boolean} [arg4] - A logical value that specifies whether to find the closest match in the first column (sorted in ascending order) (true or omitted) + * or find an exact match (false). + * @returns {number | string} */ ApiWorksheetFunction.prototype.VLOOKUP = function (arg1, arg2, arg3, arg4) { return 0; }; /** - * Returns the result of calculating the function. + * The error value. + * * "#NULL!" - 1 + * * "#DIV/0!" - 2 + * * "#VALUE!" - 3 + * * "#REF!" - 4 + * * "#NAME?" - 5 + * * "#NUM!" - 6 + * * "#N/A" - 7 + * * "#GETTING_DATA" - 8 + * * "Other" - "#N/A" + * @typedef {("#NULL!" | "#DIV/0!" | "#VALUE!" | "#REF!" | "#NAME?" | "#NUM!" | "#N/A" | "#GETTING_DATA")} ErrorValue + * */ + +/** + * Returns a number matching an error value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ErrorValue | ApiRange | ApiName} arg1 - The error value for which the identifying number will be returned. It can be an actual error value or a reference to a cell containing an error value. + * @returns {number} */ ApiWorksheetFunction.prototype.ERROR_TYPE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Checks whether a value is an error other than #N/A, and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {number | string | boolean | ApiRange | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISERR = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISERR = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a value is an error, and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {number | string | boolean | ApiRange | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISERROR = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISERROR = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Returns true if a number is even. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to test. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISEVEN = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISEVEN = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a reference to a cell contains a formula, and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} arg1 - A cell range to test. This argument can be a range or a range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISFORMULA = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISFORMULA = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a value is a logical value (true or false), and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | string | number | boolean | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISLOGICAL = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISLOGICAL = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a value is #N/A, and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | string | number | boolean | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISNA = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISNA = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a value is not text (blank cells are not text), and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | string | number | boolean | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISNONTEXT = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISNONTEXT = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a value is a number, and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | string | number | boolean | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISNUMBER = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISNUMBER = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Returns true if a number is odd. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number} arg1 - The value to test. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISODD = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISODD = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a value is a reference, and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | string | number | boolean | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISREF = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISREF = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a value is text, and returns true or false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | string | number | boolean | ApiName} arg1 - The value to test. + * The value can be an empty cell, error, logical value, text, number, range, or range name. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.ISTEXT = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.ISTEXT = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Converts a value to a number, dates to serial numbers, true to 1, error to {@link global#ErrorValue ErrorValue}, anything else to 0 (zero). * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string | boolean} arg1 - The value to be converted. The value can be a logical value, text, or number. + * @returns {number} */ ApiWorksheetFunction.prototype.N = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the #N/A error value which means "no value is available". * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @returns {string} */ -ApiWorksheetFunction.prototype.NA = function () { return 0; }; +ApiWorksheetFunction.prototype.NA = function () { return ""; }; /** - * Returns the result of calculating the function. + * Returns the sheet number of the reference sheet. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {string} [arg1]. - * @returns {number | string | boolean} + * @param {string | ApiRange | ApiName} [arg1] - The name of a sheet or a reference for which the sheet number will be returned. If omitted the number of the sheet containing the function is returned. + * @returns {number} */ ApiWorksheetFunction.prototype.SHEET = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns the number of sheets in a reference. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {ApiRange} [arg1]. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName} [arg1] - A reference for which the number of sheets will be returned. If omitted the number of sheets in the workbook containing the function is returned. + * @returns {number} */ ApiWorksheetFunction.prototype.SHEETS = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @returns {number | string | boolean} + * @param {number | string | boolean | Array | ApiRange | ApiName} arg1 - A value to test. + * @returns {number} */ ApiWorksheetFunction.prototype.TYPE = function (arg1) { return 0; }; /** - * Returns the result of calculating the function. + * Checks whether all conditions in a test are true. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | string | ApiRange | boolean | ApiName} args - A condition to check. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.AND = function () { return 0; }; +ApiWorksheetFunction.prototype.AND = function () { return true; }; /** - * Returns the result of calculating the function. + * Returns the false logical value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @returns {boolean} */ -ApiWorksheetFunction.prototype.FALSE = function () { return 0; }; +ApiWorksheetFunction.prototype.FALSE = function () { return true; }; /** - * Returns the result of calculating the function. + * Checks whether a condition is met, and returns one value if true, and another value if false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {boolean} arg1. - * @param {any} arg2. - * @param {any} [arg3]. + * @param {number | string | ApiRange | ApiName | boolean} arg1 - Any value or expression that can be evaluated to true or false. + * @param {number | string | ApiRange | ApiName | boolean} arg2 - The value that is returned if the condition is true. If omitted, true is returned. You can nest up to seven IF functions. + * @param {ApiRange | ApiName | number | string | boolean} [arg3] - The value that is returned if the condition is false. If omitted, false is returned. * @returns {number | string | boolean} */ ApiWorksheetFunction.prototype.IF = function (arg1, arg2, arg3) { return 0; }; /** - * Returns the result of calculating the function. + * Checks if there is an error in the formula in the first argument. The function returns the result of the formula if there is no error, or the value specified in the second argument if there is one. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. + * @param {ApiRange | ApiName | number | string | boolean} arg1 - The value, expression, or reference that is checked for an error. + * @param {ApiRange | ApiName | number | string | boolean} arg2 - The value to be returned if the formula evaluates to an error. The following errors are evaluated: #N/A, #VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, #NULL!. * @returns {number | string | boolean} */ ApiWorksheetFunction.prototype.IFERROR = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Checks if there is an error in the formula in the first argument. The function returns the specified value if the formula returns the #N/A error value, otherwise returns the result of the formula. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {any} arg1. - * @param {any} arg2. + * @param {ApiRange | ApiName | number | string | boolean} arg1 - The value, expression, or reference that is checked for an error. + * @param {ApiRange | ApiName | number | string | boolean} arg2 - The value to return if the formula evaluates to the #N/A error value. * @returns {number | string | boolean} */ ApiWorksheetFunction.prototype.IFNA = function (arg1, arg2) { return 0; }; /** - * Returns the result of calculating the function. + * Checks if the specified logical value is true or false. The function returns true if the argument is false and false if the argument is true. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @param {boolean} arg1. - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | number | string | boolean} arg1 - A value or expression that can be evaluated to true or false. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.NOT = function (arg1) { return 0; }; +ApiWorksheetFunction.prototype.NOT = function (arg1) { return true; }; /** - * Returns the result of calculating the function. + * Checks whether any of the arguments are true. Returns false only if all arguments are false. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {number | string | ApiRange | ApiName | boolean} args - A condition to check. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.OR = function () { return 0; }; +ApiWorksheetFunction.prototype.OR = function () { return true; }; /** - * Returns the result of calculating the function. + * Returns the true logical value. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @returns {boolean} */ -ApiWorksheetFunction.prototype.TRUE = function () { return 0; }; +ApiWorksheetFunction.prototype.TRUE = function () { return true; }; /** - * Returns the result of calculating the function. + * Returns the logical Exclusive Or value of all arguments. The function returns true when the number of true inputs is odd and false when the number of true inputs is even. * @memberof ApiWorksheetFunction - * @typeofeditors ["CSE"] - * @returns {number | string | boolean} + * @param {ApiRange | ApiName | boolean | boolean[]} args - The conditions to check. + * @returns {boolean} */ -ApiWorksheetFunction.prototype.XOR = function () { return 0; }; +ApiWorksheetFunction.prototype.XOR = function () { return true; }; /** * Returns the mail merge data. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {number} nSheet - The sheet index. * @param {boolean} [bWithFormat=false] - Specifies that the data will be received with the format. * @returns {string[][]} @@ -7267,17 +7779,68 @@ ApiInterface.prototype.GetMailMergeData = function (nSheet, bWithFormat) { retur /** * Recalculates all formulas in the active workbook. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {Function} fLogger - A function which specifies the logger object for checking recalculation of formulas. * @returns {boolean} */ ApiInterface.prototype.RecalculateAllFormulas = function (fLogger) { return true; }; +/** + * Inserts the specified pivot table into an existing worksheet. + * @memberof ApiInterface + * @param {ApiRange} dataRef - The source data range. + * @param {ApiRange} pivotRef - A range in which the pivot table will be located. + * @param {boolean} confirmation - Specifies whether to replace the data in the specified pivot table range (if it exists) or create a dialog box for this (if it exists). + * @returns {ApiPivotTable} + * @since 8.2.0 + */ +ApiInterface.prototype.InsertPivotExistingWorksheet = function (dataRef, pivotRef, confirmation) { return new ApiPivotTable(); }; + +/** + * Inserts the specified pivot table into a new worksheet. + * @memberof ApiInterface + * @param {ApiRange} dataRef - The source data range. + * @param {ApiRange} [newSheetName] - A new worksheet name. + * @returns {ApiPivotTable} + * @since 8.2.0 + */ +ApiInterface.prototype.InsertPivotNewWorksheet = function (dataRef, newSheetName) { return new ApiPivotTable(); }; + +/** + * Returns a pivot table by its name, or null if it does not exist. + * @memberof ApiInterface + * @param {string} name - The pivot table name. + * @returns {ApiPivotTable|null} + * @since 8.2.0 + */ +ApiInterface.prototype.GetPivotByName = function (name) { return new ApiPivotTable(); }; + +/** + * Refreshes all pivot tables. + * @memberof ApiInterface + * @since 8.2.0 + */ +ApiInterface.prototype.RefreshAllPivots = function () {}; + +/** + * Returns all pivot tables. + * @memberof ApiInterface + * @returns {ApiPivotTable[]} + * @since 8.2.0 + */ +ApiInterface.prototype.GetAllPivotTables = function () { return [new ApiPivotTable()]; }; + +/** + * Returns all pivot tables. + * @memberof ApiInterface + * @returns {ApiPivotTable[]} + * @since 8.2.0 + */ +ApiInterface.prototype.PivotTables = ApiInterface.prototype.GetAllPivotTables (); + /** * Subscribes to the specified event and calls the callback function when the event fires. * @function * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} eventName - The event name. * @param {function} callback - Function to be called when the event fires. * @fires Api#onWorksheetChange @@ -7288,7 +7851,6 @@ ApiInterface.prototype["attachEvent"] = ApiInterface.prototype.attachEvent;{}; * Unsubscribes from the specified event. * @function * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} eventName - The event name. * @fires Api#onWorksheetChange */ @@ -7297,7 +7859,6 @@ ApiInterface.prototype["detachEvent"] = ApiInterface.prototype.detachEvent;{}; /** * Returns an array of ApiComment objects. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} sText - The comment text. * @param {string} sAuthor - The author's name (optional). * @returns {ApiComment | null} @@ -7308,7 +7869,6 @@ ApiInterface.prototype.AddComment = function (sText, sAuthor) { return new ApiCo /** * Returns a comment from the current document by its ID. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {string} sId - The comment ID. * @returns {ApiComment} */ @@ -7317,7 +7877,6 @@ ApiInterface.prototype.GetCommentById = function (sId) { return new ApiComment() /** * Returns all comments related to the whole workbook. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiComment[]} */ ApiInterface.prototype.GetComments = function () { return [new ApiComment()]; }; @@ -7325,7 +7884,6 @@ ApiInterface.prototype.GetComments = function () { return [new ApiComment()]; }; /** * Returns all comments related to the whole workbook. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiComment[]} */ ApiInterface.prototype.Comments = ApiInterface.prototype.GetComments (); @@ -7333,7 +7891,6 @@ ApiInterface.prototype.Comments = ApiInterface.prototype.GetComments (); /** * Returns all comments from the current workbook including comments from all worksheets. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiComment[]} */ ApiInterface.prototype.GetAllComments = function () { return [new ApiComment()]; }; @@ -7341,7 +7898,6 @@ ApiInterface.prototype.GetAllComments = function () { return [new ApiComment()]; /** * Returns all comments from the current workbook including comments from all worksheets. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {ApiComment[]} */ ApiInterface.prototype.AllComments = ApiInterface.prototype.GetAllComments (); @@ -7354,7 +7910,6 @@ ApiInterface.prototype.AllComments = ApiInterface.prototype.GetAllComments (); /** * Sets a type to the freeze panes. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @param {FreezePaneType} FreezePaneType - The freeze panes type ("null" to unfreeze). * @since 8.0.0 */ @@ -7363,7 +7918,6 @@ ApiInterface.prototype.SetFreezePanesType = function (FreezePaneType) {}; /** * Returns the freeze panes type. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {FreezePaneType} FreezePaneType - The freeze panes type ("null" if there are no freeze panes). * @since 8.0.0 */ @@ -7372,40 +7926,73 @@ ApiInterface.prototype.GetFreezePanesType = function () { return new FreezePaneT /** * Returns the freeze panes type. * @memberof ApiInterface - * @typeofeditors ["CSE"] * @returns {FreezePaneType} FreezePaneType - The freeze panes type ("null" if there are no freeze panes). * @since 8.0.0 */ ApiInterface.prototype.FreezePanes = ApiInterface.prototype.GetFreezePanesType (); /** - * Returns the cell references style. + * Returns the cell reference style. * @memberof ApiInterface - * @typeofeditors ["CSE"] - * @returns {ReferenceStyle} - * */ + * @returns {ReferenceStyle} - The cell reference style. + * @since 8.1.0 + */ ApiInterface.prototype.GetReferenceStyle = function () { return new ReferenceStyle(); }; /** - * Sets the cell references style. + * Sets the cell reference style. * @memberof ApiInterface - * @typeofeditors ["CSE"] - * @param {ReferenceStyle} sReferenceStyle - Type of reference style + * @param {ReferenceStyle} sReferenceStyle - The cell reference style. + * @since 8.1.0 */ ApiInterface.prototype.SetReferenceStyle = function (sReferenceStyle) {}; /** - * Sets the cell references style. + * Sets the cell reference style. * @memberof ApiInterface - * @typeofeditors ["CSE"] - * @param {ReferenceStyle} sReferenceStyle - Type of reference style + * @param {ReferenceStyle} sReferenceStyle - The cell reference style. + * @since 8.1.0 */ ApiInterface.prototype.ReferenceStyle = ApiInterface.prototype.SetReferenceStyle (); +/** + * Returns the document information: + * Application - the application the document has been created with. + * CreatedRaw - the date and time when the file was created. + * Created - the parsed date and time when the file was created. + * LastModifiedRaw - the date and time when the file was last modified. + * LastModified - the parsed date and time when the file was last modified. + * LastModifiedBy - the name of the user who has made the latest change to the document. + * Authors - the persons who has created the file. + * Title - this property allows you to simplify your documents classification. + * Tags - this property allows you to simplify your documents classification. + * Subject - this property allows you to simplify your documents classification. + * Comment - this property allows you to simplify your documents classification. + * @memberof ApiInterface + * @returns {object} + */ +ApiInterface.prototype.GetDocumentInfo = function(){ return new object(); }; + +/** + * Returns the core properties interface for the workbook. + * This method is used to view or modify standard metadata such as title, author, and keywords. + * @memberof ApiInterface + * @returns {ApiCore} + * @since 9.0.0 + */ +ApiInterface.prototype.GetCore = function () { return new ApiCore(); }; + +/** + * Returns the workbook custom properties. + * @memberof ApiInterface + * @returns {ApiCustomProperties} + * @since 9.0.0 + */ +ApiInterface.prototype.GetCustomProperties = function () { return new ApiCustomProperties(); }; + /** * Returns the state of sheet visibility. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {boolean} */ ApiWorksheet.prototype.GetVisible = function () { return true; }; @@ -7413,7 +8000,6 @@ ApiWorksheet.prototype.GetVisible = function () { return true; }; /** * Sets the state of sheet visibility. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} isVisible - Specifies if the sheet is visible or not. */ ApiWorksheet.prototype.SetVisible = function (isVisible) {}; @@ -7421,7 +8007,6 @@ ApiWorksheet.prototype.SetVisible = function (isVisible) {}; /** * Sets the state of sheet visibility. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} isVisible - Specifies if the sheet is visible or not. */ ApiWorksheet.prototype.Visible = ApiWorksheet.prototype.SetVisible (); @@ -7429,21 +8014,18 @@ ApiWorksheet.prototype.Visible = ApiWorksheet.prototype.SetVisible (); /** * Makes the current sheet active. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] */ ApiWorksheet.prototype.SetActive = function () {}; /** * Makes the current sheet active. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] */ ApiWorksheet.prototype.Active = ApiWorksheet.prototype.SetActive (); /** * Returns an object that represents an active cell. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiWorksheet.prototype.GetActiveCell = function () { return new ApiRange(); }; @@ -7451,7 +8033,6 @@ ApiWorksheet.prototype.GetActiveCell = function () { return new ApiRange(); }; /** * Returns an object that represents an active cell. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiWorksheet.prototype.ActiveCell = ApiWorksheet.prototype.GetActiveCell (); @@ -7459,7 +8040,6 @@ ApiWorksheet.prototype.ActiveCell = ApiWorksheet.prototype.GetActiveCell (); /** * Returns an object that represents the selected range. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiWorksheet.prototype.GetSelection = function () { return new ApiRange(); }; @@ -7467,7 +8047,6 @@ ApiWorksheet.prototype.GetSelection = function () { return new ApiRange(); }; /** * Returns an object that represents the selected range. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiWorksheet.prototype.Selection = ApiWorksheet.prototype.GetSelection (); @@ -7475,7 +8054,6 @@ ApiWorksheet.prototype.Selection = ApiWorksheet.prototype.GetSelection (); /** * Returns the ApiRange that represents all the cells on the worksheet (not just the cells that are currently in use). * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} row - The row number or the cell number (if only row is defined). * @param {number} col - The column number. * @returns {ApiRange | null} @@ -7485,7 +8063,6 @@ ApiWorksheet.prototype.GetCells = function (row, col) { return new ApiRange(); } /** * Returns the ApiRange that represents all the cells on the worksheet (not just the cells that are currently in use). * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} row - The row number or the cell number (if only row is defined). * @param {number} col - The column number. * @returns {ApiRange | null} @@ -7495,7 +8072,6 @@ ApiWorksheet.prototype.Cells = ApiWorksheet.prototype.GetCells (); /** * Returns the ApiRange object that represents all the cells on the rows range. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string | number} value - Specifies the rows range in the string or number format. * @returns {ApiRange | null} */ @@ -7504,7 +8080,6 @@ ApiWorksheet.prototype.GetRows = function (value) { return new ApiRange(); }; /** * Returns the ApiRange object that represents all the cells on the columns range. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sRange - Specifies the columns range in the string format. * @returns {ApiRange} */ @@ -7513,7 +8088,6 @@ ApiWorksheet.prototype.GetCols = function (sRange) { return new ApiRange(); }; /** * Returns the ApiRange object that represents all the cells on the columns range. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sRange - Specifies the columns range in the string format. * @returns {ApiRange} */ @@ -7522,7 +8096,6 @@ ApiWorksheet.prototype.Cols = ApiWorksheet.prototype.GetCols (); /** * Returns the ApiRange object that represents the used range on the specified worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiWorksheet.prototype.GetUsedRange = function () { return new ApiRange(); }; @@ -7530,7 +8103,6 @@ ApiWorksheet.prototype.GetUsedRange = function () { return new ApiRange(); }; /** * Returns the ApiRange object that represents the used range on the specified worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiWorksheet.prototype.UsedRange = ApiWorksheet.prototype.GetUsedRange (); @@ -7538,7 +8110,6 @@ ApiWorksheet.prototype.UsedRange = ApiWorksheet.prototype.GetUsedRange (); /** * Returns a sheet name. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {string} */ ApiWorksheet.prototype.GetName = function () { return ""; }; @@ -7546,7 +8117,6 @@ ApiWorksheet.prototype.GetName = function () { return ""; }; /** * Sets a name to the current active sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sName - The name which will be displayed for the current sheet at the sheet tab. */ ApiWorksheet.prototype.SetName = function (sName) {}; @@ -7554,7 +8124,6 @@ ApiWorksheet.prototype.SetName = function (sName) {}; /** * Sets a name to the current active sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sName - The name which will be displayed for the current sheet at the sheet tab. */ ApiWorksheet.prototype.Name = ApiWorksheet.prototype.SetName (); @@ -7562,7 +8131,6 @@ ApiWorksheet.prototype.Name = ApiWorksheet.prototype.SetName (); /** * Returns a sheet index. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} */ ApiWorksheet.prototype.GetIndex = function () { return 0; }; @@ -7570,7 +8138,6 @@ ApiWorksheet.prototype.GetIndex = function () { return 0; }; /** * Returns a sheet index. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} */ ApiWorksheet.prototype.Index = ApiWorksheet.prototype.GetIndex (); @@ -7579,7 +8146,6 @@ ApiWorksheet.prototype.Index = ApiWorksheet.prototype.GetIndex (); * Returns an object that represents the selected range of the current sheet. Can be a single cell - A1, or cells * from a single row - A1:E1, or cells from a single column - A1:A10, or cells from several rows and columns - A1:E10. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string | ApiRange} Range1 - The range of cells from the current sheet. * @param {string | ApiRange} Range2 - The range of cells from the current sheet. * @returns {ApiRange | null} - returns null if such a range does not exist. @@ -7589,7 +8155,6 @@ ApiWorksheet.prototype.GetRange = function (Range1, Range2) { return new ApiRang /** * Returns an object that represents the selected range of the current sheet using the row/column coordinates for the cell selection. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} nRow - The row number. * @param {number} nCol - The column number. * @returns {ApiRange} @@ -7600,7 +8165,6 @@ ApiWorksheet.prototype.GetRangeByNumber = function (nRow, nCol) { return new Api * Formats the selected range of cells from the current sheet as a table (with the first row formatted as a header). * As the first row is always formatted as a table header, you need to select at least two rows for the table to be formed correctly. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sRange - The range of cells from the current sheet which will be formatted as a table. */ ApiWorksheet.prototype.FormatAsTable = function (sRange) {}; @@ -7610,7 +8174,6 @@ ApiWorksheet.prototype.FormatAsTable = function (sRange) {}; * One unit of column width is equal to the width of one character in the Normal style. * For proportional fonts, the width of the character 0 (zero) is used. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} nColumn - The number of the column to set the width to. * @param {number} nWidth - The width of the column divided by 7 pixels. * @param {boolean} [bWithotPaddings=false] - Specifies whether nWidth will be set without standard paddings. @@ -7621,7 +8184,6 @@ ApiWorksheet.prototype.SetColumnWidth = function (nColumn, nWidth, bWithotPaddin * Sets the height of the specified row measured in points. * A point is 1/72 inch. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} nRow - The number of the row to set the height to. * @param {number} nHeight - The height of the row measured in points. */ @@ -7630,7 +8192,6 @@ ApiWorksheet.prototype.SetRowHeight = function (nRow, nHeight) {}; /** * Specifies whether the current sheet gridlines must be displayed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} isDisplayed - Specifies whether the current sheet gridlines must be displayed or not. The default value is true. */ ApiWorksheet.prototype.SetDisplayGridlines = function (isDisplayed) {}; @@ -7638,7 +8199,6 @@ ApiWorksheet.prototype.SetDisplayGridlines = function (isDisplayed) {}; /** * Specifies whether the current sheet row/column headers must be displayed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} isDisplayed - Specifies whether the current sheet row/column headers must be displayed or not. The default value is true. */ ApiWorksheet.prototype.SetDisplayHeadings = function (isDisplayed) {}; @@ -7646,7 +8206,6 @@ ApiWorksheet.prototype.SetDisplayHeadings = function (isDisplayed) {}; /** * Sets the left margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} nPoints - The left margin size measured in points. */ ApiWorksheet.prototype.SetLeftMargin = function (nPoints) {}; @@ -7654,7 +8213,6 @@ ApiWorksheet.prototype.SetLeftMargin = function (nPoints) {}; /** * Returns the left margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The left margin size measured in points. */ ApiWorksheet.prototype.GetLeftMargin = function () { return 0; }; @@ -7662,7 +8220,6 @@ ApiWorksheet.prototype.GetLeftMargin = function () { return 0; }; /** * Returns the left margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The left margin size measured in points. */ ApiWorksheet.prototype.LeftMargin = ApiWorksheet.prototype.GetLeftMargin (); @@ -7670,7 +8227,6 @@ ApiWorksheet.prototype.LeftMargin = ApiWorksheet.prototype.GetLeftMargin (); /** * Sets the right margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} nPoints - The right margin size measured in points. */ ApiWorksheet.prototype.SetRightMargin = function (nPoints) {}; @@ -7678,7 +8234,6 @@ ApiWorksheet.prototype.SetRightMargin = function (nPoints) {}; /** * Returns the right margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The right margin size measured in points. */ ApiWorksheet.prototype.GetRightMargin = function () { return 0; }; @@ -7686,7 +8241,6 @@ ApiWorksheet.prototype.GetRightMargin = function () { return 0; }; /** * Returns the right margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The right margin size measured in points. */ ApiWorksheet.prototype.RightMargin = ApiWorksheet.prototype.GetRightMargin (); @@ -7694,7 +8248,6 @@ ApiWorksheet.prototype.RightMargin = ApiWorksheet.prototype.GetRightMargin (); /** * Sets the top margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} nPoints - The top margin size measured in points. */ ApiWorksheet.prototype.SetTopMargin = function (nPoints) {}; @@ -7702,7 +8255,6 @@ ApiWorksheet.prototype.SetTopMargin = function (nPoints) {}; /** * Returns the top margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The top margin size measured in points. */ ApiWorksheet.prototype.GetTopMargin = function () { return 0; }; @@ -7710,7 +8262,6 @@ ApiWorksheet.prototype.GetTopMargin = function () { return 0; }; /** * Returns the top margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The top margin size measured in points. */ ApiWorksheet.prototype.TopMargin = ApiWorksheet.prototype.GetTopMargin (); @@ -7718,7 +8269,6 @@ ApiWorksheet.prototype.TopMargin = ApiWorksheet.prototype.GetTopMargin (); /** * Sets the bottom margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {number} nPoints - The bottom margin size measured in points. */ ApiWorksheet.prototype.SetBottomMargin = function (nPoints) {}; @@ -7726,7 +8276,6 @@ ApiWorksheet.prototype.SetBottomMargin = function (nPoints) {}; /** * Returns the bottom margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The bottom margin size measured in points. */ ApiWorksheet.prototype.GetBottomMargin = function () { return 0; }; @@ -7734,7 +8283,6 @@ ApiWorksheet.prototype.GetBottomMargin = function () { return 0; }; /** * Returns the bottom margin of the sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {number} - The bottom margin size measured in points. */ ApiWorksheet.prototype.BottomMargin = ApiWorksheet.prototype.GetBottomMargin (); @@ -7742,79 +8290,69 @@ ApiWorksheet.prototype.BottomMargin = ApiWorksheet.prototype.GetBottomMargin (); /** * Sets the page orientation. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {PageOrientation} sPageOrientation - The page orientation type. - * */ + */ ApiWorksheet.prototype.SetPageOrientation = function (sPageOrientation) {}; /** * Returns the page orientation. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {PageOrientation} - * */ + */ ApiWorksheet.prototype.GetPageOrientation = function () { return new PageOrientation(); }; /** * Returns the page orientation. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {PageOrientation} - * */ + */ ApiWorksheet.prototype.PageOrientation = ApiWorksheet.prototype.GetPageOrientation (); /** * Returns the page PrintHeadings property which specifies whether the current sheet row/column headings must be printed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {boolean} - Specifies whether the current sheet row/column headings must be printed or not. - * */ + */ ApiWorksheet.prototype.GetPrintHeadings = function () { return true; }; /** * Specifies whether the current sheet row/column headers must be printed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} bPrint - Specifies whether the current sheet row/column headers must be printed or not. - * */ + */ ApiWorksheet.prototype.SetPrintHeadings = function (bPrint) {}; /** * Specifies whether the current sheet row/column headers must be printed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} bPrint - Specifies whether the current sheet row/column headers must be printed or not. - * */ + */ ApiWorksheet.prototype.PrintHeadings = ApiWorksheet.prototype.SetPrintHeadings (); /** * Returns the page PrintGridlines property which specifies whether the current sheet gridlines must be printed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {boolean} - True if cell gridlines are printed on this page. - * */ + */ ApiWorksheet.prototype.GetPrintGridlines = function () { return true; }; /** * Specifies whether the current sheet gridlines must be printed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} bPrint - Defines if cell gridlines are printed on this page or not. - * */ + */ ApiWorksheet.prototype.SetPrintGridlines = function (bPrint) {}; /** * Specifies whether the current sheet gridlines must be printed or not. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {boolean} bPrint - Defines if cell gridlines are printed on this page or not. - * */ + */ ApiWorksheet.prototype.PrintGridlines = ApiWorksheet.prototype.SetPrintGridlines (); /** * Returns an array of ApiName objects. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiName[]} */ ApiWorksheet.prototype.GetDefNames = function () { return [new ApiName()]; }; @@ -7822,7 +8360,6 @@ ApiWorksheet.prototype.GetDefNames = function () { return [new ApiName()]; }; /** * Returns the ApiName object by the worksheet name. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} defName - The worksheet name. * @returns {ApiName | null} - returns null if definition name doesn't exist. */ @@ -7831,7 +8368,6 @@ ApiWorksheet.prototype.GetDefName = function (defName) { return new ApiName(); } /** * Adds a new name to the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sName - The range name. * @param {string} sRef - Must contain the sheet name, followed by sign ! and a range of cells. * Example: "Sheet1!$A$1:$B$2". @@ -7843,7 +8379,6 @@ ApiWorksheet.prototype.AddDefName = function (sName, sRef, isHidden) { return tr /** * Adds a new name to the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sName - The range name. * @param {string} sRef - Must contain the sheet name, followed by sign ! and a range of cells. * Example: "Sheet1!$A$1:$B$2". @@ -7855,7 +8390,6 @@ ApiWorksheet.prototype.DefNames = ApiWorksheet.prototype.AddDefName (); /** * Returns all comments from the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiComment[]} */ ApiWorksheet.prototype.GetComments = function () { return [new ApiComment()]; }; @@ -7863,7 +8397,6 @@ ApiWorksheet.prototype.GetComments = function () { return [new ApiComment()]; }; /** * Returns all comments from the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiComment[]} */ ApiWorksheet.prototype.Comments = ApiWorksheet.prototype.GetComments (); @@ -7871,20 +8404,18 @@ ApiWorksheet.prototype.Comments = ApiWorksheet.prototype.GetComments (); /** * Deletes the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] */ ApiWorksheet.prototype.Delete = function () {}; /** * Adds a hyperlink to the specified range. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sRange - The range where the hyperlink will be added to. * @param {string} sAddress - The link address. - * @param {string} subAddress - The link subaddress to insert internal sheet hyperlinks. - * @param {string} sScreenTip - The screen tip text. - * @param {string} sTextToDisplay - The link text that will be displayed on the sheet. - * */ + * @param {string} [subAddress] - The link subaddress to insert internal sheet hyperlinks. + * @param {string} [sScreenTip] - The screen tip text. + * @param {string} [sTextToDisplay] - The link text that will be displayed on the sheet. + */ ApiWorksheet.prototype.SetHyperlink = function (sRange, sAddress, subAddress, sScreenTip, sTextToDisplay) {}; /** @@ -7892,7 +8423,6 @@ ApiWorksheet.prototype.SetHyperlink = function (sRange, sAddress, subAddress, sS * Please note that the horizontal and vertical offsets are calculated within the limits of the specified column and * row cells only. If this value exceeds the cell width or height, another vertical/horizontal position will be set. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sDataRange - The selected cell range which will be used to get the data for the chart, formed specifically and including the sheet name. * @param {boolean} bInRows - Specifies whether to take the data from the rows or from the columns. If true, the data from the rows will be used. * @param {ChartType} sType - The chart type used for the chart display. @@ -7913,7 +8443,6 @@ ApiWorksheet.prototype.AddChart = function (sDataRange, bInRows, sType, nStyleIn * calculated within the limits of the specified column and row cells * only. If this value exceeds the cell width or height, another vertical/horizontal position will be set. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {ShapeType} [sType="rect"] - The shape type which specifies the preset shape geometry. * @param {EMU} nWidth - The shape width in English measure units. * @param {EMU} nHeight - The shape height in English measure units. @@ -7924,13 +8453,12 @@ ApiWorksheet.prototype.AddChart = function (sDataRange, bInRows, sType, nStyleIn * @param {number} nFromRow - The number of the row where the beginning of the shape will be placed. * @param {EMU} nRowOffset - The offset from the nFromRow row to the upper part of the shape measured in English measure units. * @returns {ApiShape} - * */ + */ ApiWorksheet.prototype.AddShape = function (sType, nWidth, nHeight, oFill, oStroke, nFromCol, nColOffset, nFromRow, nRowOffset) { return new ApiShape(); }; /** * Adds an image to the current sheet with the parameters specified. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently only internet URL or Base64 encoded images are supported). * @param {EMU} nWidth - The image width in English measure units. * @param {EMU} nHeight - The image height in English measure units. @@ -7945,7 +8473,6 @@ ApiWorksheet.prototype.AddImage = function (sImageSrc, nWidth, nHeight, nFromCol /** * Adds a Text Art object to the current sheet with the parameters specified. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {ApiTextPr} [oTextPr=Api.CreateTextPr()] - The text properties. * @param {string} [sText="Your text here"] - The text for the Text Art object. * @param {TextTransform} [sTransform="textNoShape"] - Text transform type. @@ -7965,7 +8492,6 @@ ApiWorksheet.prototype.AddWordArt = function (oTextPr, sText, sTransform, oFill, /** * Adds an OLE object to the current sheet with the parameters specified. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). * @param {EMU} nWidth - The OLE object width in English measure units. * @param {EMU} nHeight - The OLE object height in English measure units. @@ -7982,7 +8508,6 @@ ApiWorksheet.prototype.AddOleObject = function (sImageSrc, nWidth, nHeight, sDat /** * Replaces the current image with a new one. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sImageUrl - The image source where the image to be inserted should be taken from (currently only internet URL or Base64 encoded images are supported). * @param {EMU} nWidth - The image width in English measure units. * @param {EMU} nHeight - The image height in English measure units. @@ -7992,15 +8517,13 @@ ApiWorksheet.prototype.ReplaceCurrentImage = function (sImageUrl, nWidth, nHeigh /** * Returns all drawings from the current sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] - * @returns {ApiDrawing[]}. + * @returns {Drawing[]}. */ -ApiWorksheet.prototype.GetAllDrawings = function () { return [new ApiDrawing()]; }; +ApiWorksheet.prototype.GetAllDrawings = function () { return [new Drawing()]; }; /** * Returns all images from the current sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiImage[]}. */ ApiWorksheet.prototype.GetAllImages = function () { return [new ApiImage()]; }; @@ -8008,7 +8531,6 @@ ApiWorksheet.prototype.GetAllImages = function () { return [new ApiImage()]; }; /** * Returns all shapes from the current sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiShape[]}. */ ApiWorksheet.prototype.GetAllShapes = function () { return [new ApiShape()]; }; @@ -8016,7 +8538,6 @@ ApiWorksheet.prototype.GetAllShapes = function () { return [new ApiShape()]; }; /** * Returns all charts from the current sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiChart[]}. */ ApiWorksheet.prototype.GetAllCharts = function () { return [new ApiChart()]; }; @@ -8024,7 +8545,6 @@ ApiWorksheet.prototype.GetAllCharts = function () { return [new ApiChart()]; }; /** * Returns all OLE objects from the current sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiOleObject[]}. */ ApiWorksheet.prototype.GetAllOleObjects = function () { return [new ApiOleObject()]; }; @@ -8032,16 +8552,46 @@ ApiWorksheet.prototype.GetAllOleObjects = function () { return [new ApiOleObject /** * Moves the current sheet to another location in the workbook. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {ApiWorksheet} before - The sheet before which the current sheet will be placed. You cannot specify "before" if you specify "after". * @param {ApiWorksheet} after - The sheet after which the current sheet will be placed. You cannot specify "after" if you specify "before". */ ApiWorksheet.prototype.Move = function (before, after) {}; +/** + * Returns a pivot table by its name from the current worksheet, or null if it does not exist. + * @memberof ApiWorksheet + * @param {string} name - The pivot table name. + * @returns {ApiPivotTable|null} + * @since 8.2.0 + */ +ApiWorksheet.prototype.GetPivotByName = function (name) { return new ApiPivotTable(); }; + +/** + * Returns all pivot tables from the current worksheet. + * @memberof ApiWorksheet + * @returns {ApiPivotTable[]} + * @since 8.2.0 + */ +ApiWorksheet.prototype.GetAllPivotTables = function () { return [new ApiPivotTable()]; }; + +/** + * Returns all pivot tables from the current worksheet. + * @memberof ApiWorksheet + * @returns {ApiPivotTable[]} + * @since 8.2.0 + */ +ApiWorksheet.prototype.PivotTables = ApiWorksheet.prototype.GetAllPivotTables (); + +/** + * Refreshes all pivot tables on the current worksheet. + * @memberof ApiWorksheet + * @since 8.2.0 + */ +ApiWorksheet.prototype.RefreshAllPivots = function () {}; + /** * Returns the freeze panes from the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiFreezePanes} * @since 8.0.0 */ @@ -8050,7 +8600,6 @@ ApiWorksheet.prototype.GetFreezePanes = function () { return new ApiFreezePanes( /** * Returns the freeze panes from the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiFreezePanes} * @since 8.0.0 */ @@ -8059,7 +8608,6 @@ ApiWorksheet.prototype.FreezePanes = ApiWorksheet.prototype.GetFreezePanes (); /** * Creates a protected range of the specified type from the selected data range of the current sheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sTitle - The title which will be displayed for the current protected range. * @param {string} sDataRange - The selected cell range which will be used to get the data for the protected range. * @returns {ApiProtectedRange | null} @@ -8070,7 +8618,6 @@ ApiWorksheet.prototype.AddProtectedRange = function (sTitle, sDataRange) { retur /** * Returns a protected range object by its title. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @param {string} sTitle - The title of the protected range that will be returned. * @returns {ApiProtectedRange | null} * @since 8.1.0 @@ -8080,7 +8627,6 @@ ApiWorksheet.prototype.GetProtectedRange = function (sTitle) { return new ApiPro /** * Returns all protected ranges from the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiProtectedRange[] | null} * @since 8.1.0 */ @@ -8089,17 +8635,15 @@ ApiWorksheet.prototype.GetAllProtectedRanges = function () { return [new ApiProt /** * Returns all protected ranges from the current worksheet. * @memberof ApiWorksheet - * @typeofeditors ["CSE"] * @returns {ApiProtectedRange[] | null} * @since 8.1.0 */ ApiWorksheet.prototype.AllProtectedRanges = ApiWorksheet.prototype.GetAllProtectedRanges (); /** - * Pastes the contents of the Clipboard onto the sheet. - * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {ApiRange} [destination] - Object that specifies where the Clipboard contents should be pasted. If this argument is omitted, the current selection is used. + * Pastes the contents of the clipboard to the current sheet. + * @memberof ApiWorksheet + * @param {ApiRange} [destination] - The cell range where the clipboard contents should be pasted. If this argument is omitted, the current selection is used. * @since 8.1.0 */ ApiWorksheet.prototype.Paste = function (destination) {}; @@ -8117,17 +8661,17 @@ ApiWorksheet.prototype.Paste = function (destination) {}; /** * Specifies the sort order. * @typedef {("xlAscending" | "xlDescending")} SortOrder - * */ + */ /** * Specifies whether the first row of the sort range contains the header information. * @typedef {("xlNo" | "xlYes")} SortHeader - * */ + */ /** * Specifies if the sort should be by row or column. * @typedef {("xlSortColumns" | "xlSortRows")} SortOrientation - * */ + */ /** * Specifies the range angle. @@ -8142,7 +8686,6 @@ ApiWorksheet.prototype.Paste = function (destination) {}; /** * Returns a type of the ApiRange class. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {"range"} */ ApiRange.prototype.GetClassType = function () { return ""; }; @@ -8150,7 +8693,6 @@ ApiRange.prototype.GetClassType = function () { return ""; }; /** * Returns a row number for the selected cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {number} */ ApiRange.prototype.GetRow = function () { return 0; }; @@ -8158,7 +8700,6 @@ ApiRange.prototype.GetRow = function () { return 0; }; /** * Returns a row number for the selected cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {number} */ ApiRange.prototype.Row = ApiRange.prototype.GetRow (); @@ -8166,7 +8707,6 @@ ApiRange.prototype.Row = ApiRange.prototype.GetRow (); /** * Returns a column number for the selected cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {number} */ ApiRange.prototype.GetCol = function () { return 0; }; @@ -8174,7 +8714,6 @@ ApiRange.prototype.GetCol = function () { return 0; }; /** * Returns a column number for the selected cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {number} */ ApiRange.prototype.Col = ApiRange.prototype.GetCol (); @@ -8182,14 +8721,12 @@ ApiRange.prototype.Col = ApiRange.prototype.GetCol (); /** * Clears the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] */ ApiRange.prototype.Clear = function () {}; /** * Returns a Range object that represents the rows in the specified range. If the specified row is outside the Range object, a new Range will be returned that represents the cells between the columns of the original range in the specified row. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nRow - The row number (starts counting from 1, the 0 value returns an error). * @returns {ApiRange | null} */ @@ -8198,7 +8735,6 @@ ApiRange.prototype.GetRows = function (nRow) { return new ApiRange(); }; /** * Returns a Range object that represents the rows in the specified range. If the specified row is outside the Range object, a new Range will be returned that represents the cells between the columns of the original range in the specified row. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nRow - The row number (starts counting from 1, the 0 value returns an error). * @returns {ApiRange | null} */ @@ -8207,7 +8743,6 @@ ApiRange.prototype.Rows = ApiRange.prototype.GetRows (); /** * Returns a Range object that represents the columns in the specified range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nCol - The column number. * * @returns {ApiRange | null} */ @@ -8216,7 +8751,6 @@ ApiRange.prototype.GetCols = function (nCol) { return new ApiRange(); }; /** * Returns a Range object that represents the columns in the specified range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nCol - The column number. * * @returns {ApiRange | null} */ @@ -8225,7 +8759,6 @@ ApiRange.prototype.Cols = ApiRange.prototype.GetCols (); /** * Returns a Range object that represents the end in the specified direction in the specified range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {Direction} direction - The direction of end in the specified range. * * @returns {ApiRange} */ @@ -8234,7 +8767,6 @@ ApiRange.prototype.End = function (direction) { return new ApiRange(); }; /** * Returns a Range object that represents all the cells in the specified range or a specified cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} row - The row number or the cell number (if only row is defined). * @param {number} col - The column number. * @returns {ApiRange} @@ -8244,7 +8776,6 @@ ApiRange.prototype.GetCells = function (row, col) { return new ApiRange(); }; /** * Returns a Range object that represents all the cells in the specified range or a specified cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} row - The row number or the cell number (if only row is defined). * @param {number} col - The column number. * @returns {ApiRange} @@ -8254,7 +8785,6 @@ ApiRange.prototype.Cells = ApiRange.prototype.GetCells (); /** * Sets the cell offset. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nRow - The row number. * @param {number} nCol - The column number. */ @@ -8263,12 +8793,11 @@ ApiRange.prototype.SetOffset = function (nRow, nCol) {}; /** * Returns the range address. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} RowAbs - Defines if the link to the row is absolute or not. * @param {boolean} ColAbs - Defines if the link to the column is absolute or not. * @param {string} RefStyle - The reference style. * @param {boolean} External - Defines if the range is in the current file or not. - * @param {range} RelativeTo - The range which the current range is relative to. + * @param {ApiRange} RelativeTo - The range which the current range is relative to. * @returns {string | null} - returns address of range as string. */ ApiRange.prototype.GetAddress = function (RowAbs, ColAbs, RefStyle, External, RelativeTo) { return ""; }; @@ -8276,12 +8805,11 @@ ApiRange.prototype.GetAddress = function (RowAbs, ColAbs, RefStyle, External, Re /** * Returns the range address. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} RowAbs - Defines if the link to the row is absolute or not. * @param {boolean} ColAbs - Defines if the link to the column is absolute or not. * @param {string} RefStyle - The reference style. * @param {boolean} External - Defines if the range is in the current file or not. - * @param {range} RelativeTo - The range which the current range is relative to. + * @param {ApiRange} RelativeTo - The range which the current range is relative to. * @returns {string | null} - returns address of range as string. */ ApiRange.prototype.Address = ApiRange.prototype.GetAddress (); @@ -8289,7 +8817,6 @@ ApiRange.prototype.Address = ApiRange.prototype.GetAddress (); /** * Returns the rows or columns count. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {number} */ ApiRange.prototype.GetCount = function () { return 0; }; @@ -8297,7 +8824,6 @@ ApiRange.prototype.GetCount = function () { return 0; }; /** * Returns the rows or columns count. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {number} */ ApiRange.prototype.Count = ApiRange.prototype.GetCount (); @@ -8305,7 +8831,6 @@ ApiRange.prototype.Count = ApiRange.prototype.GetCount (); /** * Returns a value of the specified range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {string | string[][]} */ ApiRange.prototype.GetValue = function () { return [""]; }; @@ -8313,8 +8838,7 @@ ApiRange.prototype.GetValue = function () { return [""]; }; /** * Sets a value to the current cell or cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {string | bool | number | Array[] | Array[][]} data - The general value for the cell or cell range. + * @param {string | boolean | number | Array | Array>} data - The general value for the cell or cell range. * @returns {boolean} - returns false if such a range does not exist. */ ApiRange.prototype.SetValue = function (data) { return true; }; @@ -8322,15 +8846,13 @@ ApiRange.prototype.SetValue = function (data) { return true; }; /** * Sets a value to the current cell or cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {string | bool | number | Array[] | Array[][]} data - The general value for the cell or cell range. + * @param {string | boolean | number | Array | Array>} data - The general value for the cell or cell range. * @returns {boolean} - returns false if such a range does not exist. */ ApiRange.prototype.Value = ApiRange.prototype.SetValue (); /** * Returns a formula of the specified range. - * @typeofeditors ["CSE"] * @memberof ApiRange * @returns {string | string[][]} - return Value2 property (value without format) if formula doesn't exist. */ @@ -8338,7 +8860,6 @@ ApiRange.prototype.GetFormula = function () { return [""]; }; /** * Returns a formula of the specified range. - * @typeofeditors ["CSE"] * @memberof ApiRange * @returns {string | string[][]} - return Value2 property (value without format) if formula doesn't exist. */ @@ -8346,7 +8867,6 @@ ApiRange.prototype.Formula = ApiRange.prototype.GetFormula (); /** * Returns the Value2 property (value without format) of the specified range. - * @typeofeditors ["CSE"] * @memberof ApiRange * @returns {string | string[][]} */ @@ -8354,7 +8874,6 @@ ApiRange.prototype.GetValue2 = function () { return [""]; }; /** * Returns the Value2 property (value without format) of the specified range. - * @typeofeditors ["CSE"] * @memberof ApiRange * @returns {string | string[][]} */ @@ -8362,7 +8881,6 @@ ApiRange.prototype.Value2 = ApiRange.prototype.GetValue2 (); /** * Returns the text of the specified range. - * @typeofeditors ["CSE"] * @memberof ApiRange * @returns {string | string[][]} */ @@ -8370,7 +8888,6 @@ ApiRange.prototype.GetText = function () { return [""]; }; /** * Returns the text of the specified range. - * @typeofeditors ["CSE"] * @memberof ApiRange * @returns {string | string[][]} */ @@ -8379,7 +8896,6 @@ ApiRange.prototype.Text = ApiRange.prototype.GetText (); /** * Sets the text color to the current cell range with the previously created color object. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiColor} oColor - The color object which specifies the color to be set to the text in the cell / cell range. */ ApiRange.prototype.SetFontColor = function (oColor) {}; @@ -8387,7 +8903,6 @@ ApiRange.prototype.SetFontColor = function (oColor) {}; /** * Sets the text color to the current cell range with the previously created color object. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiColor} oColor - The color object which specifies the color to be set to the text in the cell / cell range. */ ApiRange.prototype.FontColor = ApiRange.prototype.SetFontColor (); @@ -8395,7 +8910,6 @@ ApiRange.prototype.FontColor = ApiRange.prototype.SetFontColor (); /** * Returns the value hiding property. The specified range must span an entire column or row. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {boolean} - returns true if the values in the range specified are hidden. */ ApiRange.prototype.GetHidden = function () { return true; }; @@ -8403,7 +8917,6 @@ ApiRange.prototype.GetHidden = function () { return true; }; /** * Sets the value hiding property. The specified range must span an entire column or row. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isHidden - Specifies if the values in the current range are hidden or not. */ ApiRange.prototype.SetHidden = function (isHidden) {}; @@ -8411,7 +8924,6 @@ ApiRange.prototype.SetHidden = function (isHidden) {}; /** * Sets the value hiding property. The specified range must span an entire column or row. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isHidden - Specifies if the values in the current range are hidden or not. */ ApiRange.prototype.Hidden = ApiRange.prototype.SetHidden (); @@ -8419,7 +8931,6 @@ ApiRange.prototype.Hidden = ApiRange.prototype.SetHidden (); /** * Returns the column width value. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {number} */ ApiRange.prototype.GetColumnWidth = function () { return 0; }; @@ -8429,7 +8940,6 @@ ApiRange.prototype.GetColumnWidth = function () { return 0; }; * One unit of column width is equal to the width of one character in the Normal style. * For proportional fonts, the width of the character 0 (zero) is used. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nWidth - The width of the column divided by 7 pixels. */ ApiRange.prototype.SetColumnWidth = function (nWidth) {}; @@ -8439,7 +8949,6 @@ ApiRange.prototype.SetColumnWidth = function (nWidth) {}; * One unit of column width is equal to the width of one character in the Normal style. * For proportional fonts, the width of the character 0 (zero) is used. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nWidth - The width of the column divided by 7 pixels. */ ApiRange.prototype.ColumnWidth = ApiRange.prototype.SetColumnWidth (); @@ -8447,7 +8956,6 @@ ApiRange.prototype.ColumnWidth = ApiRange.prototype.SetColumnWidth (); /** * Returns the row height value. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {pt} - The row height in the range specified, measured in points. */ ApiRange.prototype.GetRowHeight = function () { return new pt(); }; @@ -8455,7 +8963,6 @@ ApiRange.prototype.GetRowHeight = function () { return new pt(); }; /** * Sets the row height value. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {pt} nHeight - The row height in the current range measured in points. */ ApiRange.prototype.SetRowHeight = function (nHeight) {}; @@ -8463,7 +8970,6 @@ ApiRange.prototype.SetRowHeight = function (nHeight) {}; /** * Sets the row height value. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {pt} nHeight - The row height in the current range measured in points. */ ApiRange.prototype.RowHeight = ApiRange.prototype.SetRowHeight (); @@ -8471,7 +8977,6 @@ ApiRange.prototype.RowHeight = ApiRange.prototype.SetRowHeight (); /** * Sets the font size to the characters of the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nSize - The font size value measured in points. */ ApiRange.prototype.SetFontSize = function (nSize) {}; @@ -8479,7 +8984,6 @@ ApiRange.prototype.SetFontSize = function (nSize) {}; /** * Sets the font size to the characters of the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} nSize - The font size value measured in points. */ ApiRange.prototype.FontSize = ApiRange.prototype.SetFontSize (); @@ -8487,7 +8991,6 @@ ApiRange.prototype.FontSize = ApiRange.prototype.SetFontSize (); /** * Sets the specified font family as the font name for the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {string} sName - The font family name used for the current cell range. */ ApiRange.prototype.SetFontName = function (sName) {}; @@ -8495,7 +8998,6 @@ ApiRange.prototype.SetFontName = function (sName) {}; /** * Sets the specified font family as the font name for the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {string} sName - The font family name used for the current cell range. */ ApiRange.prototype.FontName = ApiRange.prototype.SetFontName (); @@ -8503,7 +9005,6 @@ ApiRange.prototype.FontName = ApiRange.prototype.SetFontName (); /** * Sets the vertical alignment of the text in the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {'center' | 'bottom' | 'top' | 'distributed' | 'justify'} sAligment - The vertical alignment that will be applied to the cell contents. * @returns {boolean} - return false if sAligment doesn't exist. */ @@ -8512,7 +9013,6 @@ ApiRange.prototype.SetAlignVertical = function (sAligment) { return true; }; /** * Sets the vertical alignment of the text in the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {'center' | 'bottom' | 'top' | 'distributed' | 'justify'} sAligment - The vertical alignment that will be applied to the cell contents. * @returns {boolean} - return false if sAligment doesn't exist. */ @@ -8521,7 +9021,6 @@ ApiRange.prototype.AlignVertical = ApiRange.prototype.SetAlignVertical (); /** * Sets the horizontal alignment of the text in the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {'left' | 'right' | 'center' | 'justify'} sAlignment - The horizontal alignment that will be applied to the cell contents. * @returns {boolean} - return false if sAligment doesn't exist. */ @@ -8530,7 +9029,6 @@ ApiRange.prototype.SetAlignHorizontal = function (sAlignment) { return true; }; /** * Sets the horizontal alignment of the text in the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {'left' | 'right' | 'center' | 'justify'} sAlignment - The horizontal alignment that will be applied to the cell contents. * @returns {boolean} - return false if sAligment doesn't exist. */ @@ -8539,7 +9037,6 @@ ApiRange.prototype.AlignHorizontal = ApiRange.prototype.SetAlignHorizontal (); /** * Sets the bold property to the text characters in the current cell or cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isBold - Specifies that the contents of the current cell / cell range are displayed bold. */ ApiRange.prototype.SetBold = function (isBold) {}; @@ -8547,7 +9044,6 @@ ApiRange.prototype.SetBold = function (isBold) {}; /** * Sets the bold property to the text characters in the current cell or cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isBold - Specifies that the contents of the current cell / cell range are displayed bold. */ ApiRange.prototype.Bold = ApiRange.prototype.SetBold (); @@ -8555,7 +9051,6 @@ ApiRange.prototype.Bold = ApiRange.prototype.SetBold (); /** * Sets the italic property to the text characters in the current cell or cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isItalic - Specifies that the contents of the current cell / cell range are displayed italicized. */ ApiRange.prototype.SetItalic = function (isItalic) {}; @@ -8563,7 +9058,6 @@ ApiRange.prototype.SetItalic = function (isItalic) {}; /** * Sets the italic property to the text characters in the current cell or cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isItalic - Specifies that the contents of the current cell / cell range are displayed italicized. */ ApiRange.prototype.Italic = ApiRange.prototype.SetItalic (); @@ -8571,35 +9065,32 @@ ApiRange.prototype.Italic = ApiRange.prototype.SetItalic (); /** * Specifies that the contents of the current cell / cell range are displayed along with a line appearing directly below the character. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {'none' | 'single' | 'singleAccounting' | 'double' | 'doubleAccounting'} undelineType - Specifies the type of the * line displayed under the characters. The following values are available: - * * "none" - for no underlining; - * * "single" - for a single line underlining the cell contents; - * * "singleAccounting" - for a single line underlining the cell contents but not protruding beyond the cell borders; - * * "double" - for a double line underlining the cell contents; - * * "doubleAccounting" - for a double line underlining the cell contents but not protruding beyond the cell borders. + * "none" - for no underlining; + * "single" - for a single line underlining the cell contents; + * "singleAccounting" - for a single line underlining the cell contents but not protruding beyond the cell borders; + * "double" - for a double line underlining the cell contents; + * "doubleAccounting" - for a double line underlining the cell contents but not protruding beyond the cell borders. */ ApiRange.prototype.SetUnderline = function (undelineType) {}; /** * Specifies that the contents of the current cell / cell range are displayed along with a line appearing directly below the character. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {'none' | 'single' | 'singleAccounting' | 'double' | 'doubleAccounting'} undelineType - Specifies the type of the * line displayed under the characters. The following values are available: - * * "none" - for no underlining; - * * "single" - for a single line underlining the cell contents; - * * "singleAccounting" - for a single line underlining the cell contents but not protruding beyond the cell borders; - * * "double" - for a double line underlining the cell contents; - * * "doubleAccounting" - for a double line underlining the cell contents but not protruding beyond the cell borders. + * "none" - for no underlining; + * "single" - for a single line underlining the cell contents; + * "singleAccounting" - for a single line underlining the cell contents but not protruding beyond the cell borders; + * "double" - for a double line underlining the cell contents; + * "doubleAccounting" - for a double line underlining the cell contents but not protruding beyond the cell borders. */ ApiRange.prototype.Underline = ApiRange.prototype.SetUnderline (); /** * Specifies that the contents of the cell / cell range are displayed with a single horizontal line through the center of the contents. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isStrikeout - Specifies if the contents of the current cell / cell range are displayed struck through. */ ApiRange.prototype.SetStrikeout = function (isStrikeout) {}; @@ -8607,7 +9098,6 @@ ApiRange.prototype.SetStrikeout = function (isStrikeout) {}; /** * Specifies that the contents of the cell / cell range are displayed with a single horizontal line through the center of the contents. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isStrikeout - Specifies if the contents of the current cell / cell range are displayed struck through. */ ApiRange.prototype.Strikeout = ApiRange.prototype.SetStrikeout (); @@ -8615,7 +9105,6 @@ ApiRange.prototype.Strikeout = ApiRange.prototype.SetStrikeout (); /** * Specifies whether the words in the cell must be wrapped to fit the cell size or not. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isWrap - Specifies if the words in the cell will be wrapped to fit the cell size. */ ApiRange.prototype.SetWrap = function (isWrap) {}; @@ -8623,7 +9112,6 @@ ApiRange.prototype.SetWrap = function (isWrap) {}; /** * Returns the information about the wrapping cell style. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {boolean} */ ApiRange.prototype.GetWrapText = function () { return true; }; @@ -8631,7 +9119,6 @@ ApiRange.prototype.GetWrapText = function () { return true; }; /** * Returns the information about the wrapping cell style. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {boolean} */ ApiRange.prototype.WrapText = ApiRange.prototype.GetWrapText (); @@ -8640,7 +9127,6 @@ ApiRange.prototype.WrapText = ApiRange.prototype.GetWrapText (); * Sets the background color to the current cell range with the previously created color object. * Sets 'No Fill' when previously created color object is null. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiColor} oColor - The color object which specifies the color to be set to the background in the cell / cell range. */ ApiRange.prototype.SetFillColor = function (oColor) {}; @@ -8648,7 +9134,6 @@ ApiRange.prototype.SetFillColor = function (oColor) {}; /** * Returns the background color for the current cell range. Returns 'No Fill' when the color of the background in the cell / cell range is null. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiColor|'No Fill'} - return 'No Fill' when the color to the background in the cell / cell range is null. */ ApiRange.prototype.GetFillColor = function () { return new ApiColor(); }; @@ -8656,7 +9141,6 @@ ApiRange.prototype.GetFillColor = function () { return new ApiColor(); }; /** * Returns the background color for the current cell range. Returns 'No Fill' when the color of the background in the cell / cell range is null. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiColor|'No Fill'} - return 'No Fill' when the color to the background in the cell / cell range is null. */ ApiRange.prototype.FillColor = ApiRange.prototype.GetFillColor (); @@ -8664,7 +9148,6 @@ ApiRange.prototype.FillColor = ApiRange.prototype.GetFillColor (); /** * Returns a value that represents the format code for the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {string | null} This property returns null if all cells in the specified range don't have the same number format. */ ApiRange.prototype.GetNumberFormat = function () { return ""; }; @@ -8672,7 +9155,6 @@ ApiRange.prototype.GetNumberFormat = function () { return ""; }; /** * Specifies whether a number in the cell should be treated like number, currency, date, time, etc. or just like text. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {string} sFormat - Specifies the mask applied to the number in the cell. */ ApiRange.prototype.SetNumberFormat = function (sFormat) {}; @@ -8680,7 +9162,6 @@ ApiRange.prototype.SetNumberFormat = function (sFormat) {}; /** * Specifies whether a number in the cell should be treated like number, currency, date, time, etc. or just like text. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {string} sFormat - Specifies the mask applied to the number in the cell. */ ApiRange.prototype.NumberFormat = ApiRange.prototype.SetNumberFormat (); @@ -8688,7 +9169,6 @@ ApiRange.prototype.NumberFormat = ApiRange.prototype.SetNumberFormat (); /** * Sets the border to the cell / cell range with the parameters specified. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {BordersIndex} bordersIndex - Specifies the cell border position. * @param {LineStyle} lineStyle - Specifies the line style used to form the cell border. * @param {ApiColor} oColor - The color object which specifies the color to be set to the cell border. @@ -8698,7 +9178,6 @@ ApiRange.prototype.SetBorders = function (bordersIndex, lineStyle, oColor) {}; /** * Merges the selected cell range into a single cell or a cell row. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {boolean} isAcross - When set to true, the cells within the selected range will be merged along the rows, * but remain split in the columns. When set to false, the whole selected range of cells will be merged into a single cell. */ @@ -8707,14 +9186,12 @@ ApiRange.prototype.Merge = function (isAcross) {}; /** * Splits the selected merged cell range into the single cells. * @memberof ApiRange - * @typeofeditors ["CSE"] */ ApiRange.prototype.UnMerge = function () {}; /** * Returns one cell or cells from the merge area. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiRange | null} - returns null if range isn't one cell */ result = new ApiRange((bb) ? AscCommonExcel.Range.prototype.createFromBBox(this.range.worksheet, bb) : this.range);{ return new ApiRange(); }; @@ -8722,7 +9199,6 @@ result = new ApiRange((bb) ? AscCommonExcel.Range.prototype.createFromBBox(this. /** * Returns one cell or cells from the merge area. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiRange | null} - returns null if range isn't one cell */ ApiRange.prototype.MergeArea = new ApiRange(); @@ -8730,7 +9206,6 @@ ApiRange.prototype.MergeArea = new ApiRange(); /** * Executes a provided function once for each cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {Function} fCallback - A function which will be executed for each cell. */ ApiRange.prototype.ForEach = function (fCallback) {}; @@ -8738,7 +9213,6 @@ ApiRange.prototype.ForEach = function (fCallback) {}; /** * Adds a comment to the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {string} sText - The comment text. * @param {string} sAuthor - The author's name (optional). * @returns {ApiComment | null} - returns false if comment can't be added. @@ -8748,7 +9222,6 @@ ApiRange.prototype.AddComment = function (sText, sAuthor) { return new ApiCommen /** * Returns the Worksheet object that represents the worksheet containing the specified range. It will be available in the read-only mode. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiWorksheet} */ ApiRange.prototype.GetWorksheet = function () { return new ApiWorksheet(); }; @@ -8756,7 +9229,6 @@ ApiRange.prototype.GetWorksheet = function () { return new ApiWorksheet(); }; /** * Returns the Worksheet object that represents the worksheet containing the specified range. It will be available in the read-only mode. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiWorksheet} */ ApiRange.prototype.Worksheet = ApiRange.prototype.GetWorksheet (); @@ -8764,7 +9236,6 @@ ApiRange.prototype.Worksheet = ApiRange.prototype.GetWorksheet (); /** * Returns the ApiName object of the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiName} */ ApiRange.prototype.GetDefName = function () { return new ApiName(); }; @@ -8772,7 +9243,6 @@ ApiRange.prototype.GetDefName = function () { return new ApiName(); }; /** * Returns the ApiName object of the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiName} */ ApiRange.prototype.DefName = ApiRange.prototype.GetDefName (); @@ -8780,7 +9250,6 @@ ApiRange.prototype.DefName = ApiRange.prototype.GetDefName (); /** * Returns the ApiComment object of the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiComment | null} - returns null if range does not consist of one cell. */ ApiRange.prototype.GetComment = function () { return new ApiComment(); }; @@ -8788,7 +9257,6 @@ ApiRange.prototype.GetComment = function () { return new ApiComment(); }; /** * Returns the ApiComment object of the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiComment | null} - returns null if range does not consist of one cell. */ ApiRange.prototype.Comments = ApiRange.prototype.GetComment (); @@ -8796,14 +9264,12 @@ ApiRange.prototype.Comments = ApiRange.prototype.GetComment (); /** * Selects the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] */ ApiRange.prototype.Select = function () {}; /** * Returns the current range angle. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {Angle} */ ApiRange.prototype.GetOrientation = function () { return new Angle(); }; @@ -8811,7 +9277,6 @@ ApiRange.prototype.GetOrientation = function () { return new Angle(); }; /** * Sets an angle to the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {Angle} angle - Specifies the range angle. */ ApiRange.prototype.SetOrientation = function (angle) {}; @@ -8819,7 +9284,6 @@ ApiRange.prototype.SetOrientation = function (angle) {}; /** * Sets an angle to the current cell range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {Angle} angle - Specifies the range angle. */ ApiRange.prototype.Orientation = ApiRange.prototype.SetOrientation (); @@ -8827,7 +9291,6 @@ ApiRange.prototype.Orientation = ApiRange.prototype.SetOrientation (); /** * Sorts the cells in the given range by the parameters specified in the request. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiRange | String} key1 - First sort field. * @param {SortOrder} sSortOrder1 - The sort order for the values specified in Key1. * @param {ApiRange | String} key2 - Second sort field. @@ -8842,7 +9305,6 @@ ApiRange.prototype.SetSort = function (key1, sSortOrder1, key2, /*Type,*/ sSortO /** * Sorts the cells in the given range by the parameters specified in the request. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiRange | String} key1 - First sort field. * @param {SortOrder} sSortOrder1 - The sort order for the values specified in Key1. * @param {ApiRange | String} key2 - Second sort field. @@ -8857,32 +9319,28 @@ ApiRange.prototype.Sort = ApiRange.prototype.SetSort (); /** * Deletes the Range object. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {?string} shift - Specifies how to shift cells to replace the deleted cells ("up", "left"). + * @param {DeleteShiftDirection} [shift] - Specifies how to shift cells to replace the deleted cells. */ ApiRange.prototype.Delete = function (shift) {}; /** * Inserts a cell or a range of cells into the worksheet or macro sheet and shifts other cells away to make space. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {?string} shift - Specifies which way to shift the cells ("right", "down"). + * @param {string} [shift] - Specifies which way to shift the cells ("right", "down"). */ ApiRange.prototype.Insert = function (shift) {}; /** * Changes the width of the columns or the height of the rows in the range to achieve the best fit. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {?bool} bRows - Specifies if the width of the columns will be autofit. - * @param {?bool} bCols - Specifies if the height of the rows will be autofit. + * @param {boolean} [bRows] - Specifies if the width of the columns will be autofit. + * @param {boolean} [bCols] - Specifies if the height of the rows will be autofit. */ ApiRange.prototype.AutoFit = function (bRows, bCols) {}; /** * Returns a collection of the ranges. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiAreas} */ ApiRange.prototype.GetAreas = function () { return new ApiAreas(); }; @@ -8890,46 +9348,59 @@ ApiRange.prototype.GetAreas = function () { return new ApiAreas(); }; /** * Returns a collection of the ranges. * @memberof ApiRange - * @typeofeditors ["CSE"] * @returns {ApiAreas} */ ApiRange.prototype.Areas = ApiRange.prototype.GetAreas (); /** - * Copies the range to the specified range or to the Clipboard. + * Copies the range to the specified range or to the clipboard. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {ApiRange} [destination] - Specifies the new range to which the specified range will be copied. If this argument is omitted, Onlyoffice copies the range to the Clipboard. + * @param {ApiRange} [destination] - Specifies the new range to which the specified range will be copied. If this argument is omitted, the range will be copied to the clipboard. */ ApiRange.prototype.Copy = function (destination) {}; /** - * Cuts the range to the specified range or to the Clipboard. + * Cuts the range and save it to the clipboard or paste it to the specified range. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {ApiRange} [destination] - Specifies the new range to which the specified range will be cuted. If this argument is omitted, Onlyoffice copies the range to the Clipboard. + * @param {ApiRange} [destination] - Specifies the new range to which the cut range will be pasted. If this argument is omitted, the range will be copied to the clipboard. + * @since 8.1.0 */ ApiRange.prototype.Cut = function (destination) {}; /** * Pastes the Range object to the specified range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiRange} rangeFrom - Specifies the range to be pasted to the current range */ ApiRange.prototype.Paste = function (rangeFrom) {}; /** - * Pastes the Range object to the specified range. + * Pastes the Range object to the specified range using the special paste options. * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {PasteType} [sPasteType="xlPasteAll"] - Type of special paste - * @param {PasteSpecialOperation} [sPasteSpecialOperation="xlPasteSpecialOperationNone"] - Operation of special paste - * @param {boolean} bSkipBlanks [bSkipBlanks=false] - Case sensitive or not. The default value is "false". - * @param {boolean} bTranspose [bTranspose=false] - Case sensitive or not. The default value is "false". + * @param {PasteType} [sPasteType="xlPasteAll"] - Paste option. + * @param {PasteSpecialOperation} [sPasteSpecialOperation="xlPasteSpecialOperationNone"] - The mathematical operation which will be applied to the copied data. + * @param {boolean} bSkipBlanks [bSkipBlanks=false] - Specifies whether to avoid replacing values in the paste area when blank cells occur in the copy area. + * @param {boolean} bTranspose [bTranspose=false] - Specifies whether the pasted data will be transposed from rows to columns. + * @since 8.1.0 */ ApiRange.prototype.PasteSpecial = function (sPasteType, sPasteSpecialOperation, bSkipBlanks, bTranspose) {}; +/** + * Returns the ApiPivotTable object that represents the pivot table report containing the upper-left corner of the specified range. + * @memberof ApiRange + * @returns {ApiPivotTable | null} + * @since 8.2.0 + */ +ApiRange.prototype.GetPivotTable = function() { return new ApiPivotTable(); }; + +/** + * Returns the ApiPivotTable object that represents the pivot table report containing the upper-left corner of the specified range. + * @memberof ApiRange + * @returns {ApiPivotTable | null} + * @since 8.2.0 + */ +ApiRange.prototype.PivotTable = ApiRange.prototype.GetPivotTable (); + /** * Search data type (formulas or values). * @typedef {("xlFormulas" | "xlValues")} XlFindLookIn @@ -8977,28 +9448,14 @@ ApiRange.prototype.PasteSpecial = function (sPasteType, sPasteSpecialOperation, /** * Finds specific information in the current range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {SearchData} oSearchData - The search data used to make search. * @returns {ApiRange | null} - Returns null if the current range does not contain such text. - * @also - * Finds specific information in the current range. - * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {string | undefined} What - The data to search for. - * @param {ApiRange} After - The cell after which you want the search to begin. If this argument is not specified, the search starts after the cell in the upper-left corner of the range. - * @param {XlFindLookIn} LookIn - Search data type (formulas or values). - * @param {XlLookAt} LookAt - Specifies whether the whole search text or any part of the search text is matched. - * @param {XlSearchOrder} SearchOrder - Range search order - by rows or by columns. - * @param {XlSearchDirection} SearchDirection - Range search direction - next match or previous match. - * @param {boolean} MatchCase - Case sensitive or not. The default value is "false". - * @returns {ApiRange | null} - Returns null if the current range does not contain such text. */ ApiRange.prototype.Find = function (oSearchData) { return new ApiRange(); }; /** * Continues a search that was begun with the {@link ApiRange#Find} method. Finds the next cell that matches those same conditions and returns the ApiRange object that represents that cell. This does not affect the selection or the active cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiRange} After - The cell after which the search will start. If this argument is not specified, the search starts from the last cell found. * @returns {ApiRange | null} - Returns null if the range does not contain such text. * @@ -9008,7 +9465,6 @@ ApiRange.prototype.FindNext = function (After) { return new ApiRange(); }; /** * Continues a search that was begun with the {@link ApiRange#Find} method. Finds the previous cell that matches those same conditions and returns the ApiRange object that represents that cell. This does not affect the selection or the active cell. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ApiRange} Before - The cell before which the search will start. If this argument is not specified, the search starts from the last cell found. * @returns {ApiRange | null} - Returns null if the range does not contain such text. * @@ -9018,27 +9474,14 @@ ApiRange.prototype.FindPrevious = function (Before) { return new ApiRange(); }; /** * Replaces specific information to another one in a range. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {ReplaceData} oReplaceData - The data used to make search and replace. * @returns {ApiRange | null} - Returns null if the current range does not contain such text. - * @also - * Replaces specific information to another one in a range. - * @memberof ApiRange - * @typeofeditors ["CSE"] - * @param {string | undefined} What - The data to search for. - * @param {string} Replacement - The replacement string. - * @param {XlLookAt} LookAt - Specifies whether the whole search text or any part of the search text is matched. - * @param {XlSearchOrder} SearchOrder - Range search order - by rows or by columns. - * @param {XlSearchDirection} SearchDirection - Range search direction - next match or previous match. - * @param {boolean} MatchCase - Case sensitive or not. The default value is "false". - * @param {boolean} ReplaceAll - Specifies if all the found data will be replaced or not. The default value is "true". */ ApiRange.prototype.Replace = function (oReplaceData) { return new ApiRange(); }; /** * Returns the ApiCharacters object that represents a range of characters within the object text. Use the ApiCharacters object to format characters within a text string. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} Start - The first character to be returned. If this argument is either 1 or omitted, this property returns a range of characters starting with the first character. * @param {number} Length - The number of characters to be returned. If this argument is omitted, this property returns the remainder of the string (everything after the Start character). * @returns {ApiCharacters} @@ -9049,7 +9492,6 @@ ApiRange.prototype.GetCharacters = function (Start, Length) { return new ApiChar /** * Returns the ApiCharacters object that represents a range of characters within the object text. Use the ApiCharacters object to format characters within a text string. * @memberof ApiRange - * @typeofeditors ["CSE"] * @param {number} Start - The first character to be returned. If this argument is either 1 or omitted, this property returns a range of characters starting with the first character. * @param {number} Length - The number of characters to be returned. If this argument is omitted, this property returns the remainder of the string (everything after the Start character). * @returns {ApiCharacters} @@ -9057,10 +9499,64 @@ ApiRange.prototype.GetCharacters = function (Start, Length) { return new ApiChar */ ApiRange.prototype.Characters = ApiRange.prototype.GetCharacters (); +/** + * Filter type. + * @typedef {("xlAnd" | "xlBottom10Items" | "xlBottom10Percent" | "xlFilterCellColor" | "xlFilterDynamic" | "xlFilterFontColor" | "xlFilterValues" | "xlOr" | "xlTop10Items" | "xlTop10Percent")} XlAutoFilterOperator + */ + +/** + * Specifies the filter criterion. + * @typedef {("xlFilterAboveAverage" | "xlFilterAllDatesInPeriodApril" | "xlFilterAllDatesInPeriodAugust" | "xlFilterAllDatesInPeriodDecember" + * | "xlFilterAllDatesInPeriodFebruary" | "xlFilterAllDatesInPeriodJanuary" | "xlFilterAllDatesInPeriodJuly" | "xlFilterAllDatesInPeriodJune" + * | "xlFilterAllDatesInPeriodMarch" | "xlFilterAllDatesInPeriodMay" | "xlFilterAllDatesInPeriodNovember" | "xlFilterAllDatesInPeriodOctober" + * | "xlFilterAllDatesInPeriodQuarter1" | "xlFilterAllDatesInPeriodQuarter2" | "xlFilterAllDatesInPeriodQuarter3" | "xlFilterAllDatesInPeriodQuarter4" + * | "xlFilterBelowAverage" | "xlFilterLastMonth" | "xlFilterLastQuarter" | "xlFilterLastWeek" + * | "xlFilterLastYear" | "xlFilterNextMonth" | "xlFilterNextQuarter" | "xlFilterNextWeek" + * | "xlFilterNextYear" | "xlFilterThisMonth" | "xlFilterThisQuarter" | "xlFilterThisWeek" + * | "xlFilterThisYear" | "xlFilterToday" | "xlFilterTomorrow" | "xlFilterYearToDate" | "xlFilterYesterday")} XlDynamicFilterCriteria + */ + +/** + * Adds an AutoFilter to the current range. + * @memberof ApiRange + * @param {number} [Field] - 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 one). + * @param {string | string[] | ApiColor | XlDynamicFilterCriteria} [Criteria1] - The criteria (a string; for example, "101"). Use "=" to find blank fields, "<>" to find non-blank fields, and "><" to select (No Data) fields in data types. + * If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10"). + * @param {XlAutoFilterOperator} [Operator] - An XlAutoFilterOperator constant specifying the type of filter. + * @param {string} [Criteria2] - The second criteria (a string). Used with Criteria1 and Operator to construct compound criteria. + * @param {boolean} [VisibleDropDown] - True to display the AutoFilter drop-down arrow for the filtered field. False to hide the AutoFilter drop-down arrow for the filtered field. True by default. + * @since 8.3.0 + */ +ApiRange.prototype.SetAutoFilter = function (Field, Criteria1, Operator, Criteria2, VisibleDropDown) {}; + +/** + * Sets an array formula to the current range. + * @memberof ApiRange + * @param {string | boolean | number} data - The general value for the cell or cell range. + * @returns {boolean} - Returns false if such a range does not exist. + * @since 9.0.0 + */ +ApiRange.prototype.SetFormulaArray = function (data) { return true; }; + +/** + * Returns an array formula from the current range. + * @memberof ApiRange + * @returns {string | null} + * @since 9.0.0 + */ +ApiRange.prototype.GetFormulaArray = function () { return ""; }; + +/** + * Returns an array formula from the current range. + * @memberof ApiRange + * @returns {string | null} + * @since 9.0.0 + */ +ApiRange.prototype.FormulaArray = ApiRange.prototype.GetFormulaArray (); + /** * Returns a type of the ApiDrawing class. * @memberof ApiDrawing - * @typeofeditors ["CSE"] * @returns {"drawing"} */ ApiDrawing.prototype.GetClassType = function () { return ""; }; @@ -9068,7 +9564,6 @@ ApiDrawing.prototype.GetClassType = function () { return ""; }; /** * Sets a size of the object (image, shape, chart) bounding box. * @memberof ApiDrawing - * @typeofeditors ["CSE"] * @param {EMU} nWidth - The object width measured in English measure units. * @param {EMU} nHeight - The object height measured in English measure units. */ @@ -9079,18 +9574,16 @@ ApiDrawing.prototype.SetSize = function (nWidth, nHeight) {}; * Please note that the horizontal and vertical offsets are calculated within the limits of * the specified column and row cells only. If this value exceeds the cell width or height, another vertical/horizontal position will be set. * @memberof ApiDrawing - * @typeofeditors ["CSE"] * @param {number} nFromCol - The number of the column where the beginning of the drawing object will be placed. * @param {EMU} nColOffset - The offset from the nFromCol column to the left part of the drawing object measured in English measure units. * @param {number} nFromRow - The number of the row where the beginning of the drawing object will be placed. * @param {EMU} nRowOffset - The offset from the nFromRow row to the upper part of the drawing object measured in English measure units. - * */ + */ ApiDrawing.prototype.SetPosition = function (nFromCol, nColOffset, nFromRow, nRowOffset) {}; /** * Returns the width of the current drawing. * @memberof ApiDrawing - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {EMU} */ ApiDrawing.prototype.GetWidth = function () { return new EMU(); }; @@ -9098,34 +9591,52 @@ ApiDrawing.prototype.GetWidth = function () { return new EMU(); }; /** * Returns the height of the current drawing. * @memberof ApiDrawing - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {EMU} */ ApiDrawing.prototype.GetHeight = function () { return new EMU(); }; /** * Returns the lock value for the specified lock type of the current drawing. - * @typeofeditors ["CSE"] - * @param {"noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" - * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox"} sType - Lock type in the string format. - * @returns {bool} + * @param {DrawingLockType} sType - Lock type in the string format. + * @returns {boolean} */ ApiDrawing.prototype.GetLockValue = function (sType) { return true; }; /** * Sets the lock value to the specified lock type of the current drawing. - * @typeofeditors ["CSE"] - * @param {"noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" - * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox"} sType - Lock type in the string format. - * @param {bool} bValue - Specifies if the specified lock is applied to the current drawing. - * @returns {bool} + * @param {DrawingLockType} sType - Lock type in the string format. + * @param {boolean} bValue - Specifies if the specified lock is applied to the current drawing. + * @returns {boolean} */ ApiDrawing.prototype.SetLockValue = function (sType, bValue) { return true; }; +/** + * Returns the parent sheet of the current drawing. + * @returns {ApiWorksheet} + * @since 8.3.0 + */ +ApiDrawing.prototype.GetParentSheet = function () { return new ApiWorksheet(); }; + +/** + * Sets the rotation angle to the current drawing object. + * @memberof ApiDrawing + * @param {number} nRotAngle - New drawing rotation angle. + * @returns {boolean} + * @since 9.0.0 + */ +ApiDrawing.prototype.SetRotation = function(nRotAngle){ return true; }; + +/** + * Returns the rotation angle of the current drawing object. + * @memberof ApiDrawing + * @returns {number} + * @since 9.0.0 + */ +ApiDrawing.prototype.GetRotation = function(){ return 0; }; + /** * Returns a type of the ApiImage class. * @memberof ApiImage - * @typeofeditors ["CDE", "CSE"] * @returns {"image"} */ ApiImage.prototype.GetClassType = function () { return ""; }; @@ -9133,7 +9644,6 @@ ApiImage.prototype.GetClassType = function () { return ""; }; /** * Returns a type of the ApiShape class. * @memberof ApiShape - * @typeofeditors ["CSE"] * @returns {"shape"} */ ApiShape.prototype.GetClassType = function () { return ""; }; @@ -9141,7 +9651,6 @@ ApiShape.prototype.GetClassType = function () { return ""; }; /** * Returns the shape inner contents where a paragraph or text runs can be inserted. * @memberof ApiShape - * @typeofeditors ["CSE"] * @returns {ApiDocumentContent} */ ApiShape.prototype.GetContent = function () { return new ApiDocumentContent(); }; @@ -9149,7 +9658,6 @@ ApiShape.prototype.GetContent = function () { return new ApiDocumentContent(); } /** * Returns the shape inner contents where a paragraph or text runs can be inserted. * @memberof ApiShape - * @typeofeditors ["CSE"] * @returns {ApiDocumentContent} */ ApiShape.prototype.GetDocContent = function () { return new ApiDocumentContent(); }; @@ -9157,221 +9665,18 @@ ApiShape.prototype.GetDocContent = function () { return new ApiDocumentContent() /** * Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. * @memberof ApiShape - * @typeofeditors ["CSE"] * @param {"top" | "center" | "bottom" } sVerticalAlign - The vertical alignment type for the shape inner contents. * @returns {boolean} - returns false if shape or aligment doesn't exist. */ ApiShape.prototype.SetVerticalTextAlign = function (sVerticalAlign) { return true; }; -/** - * Returns a type of the ApiChart class. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @returns {"chart"} - */ -ApiChart.prototype.GetClassType = function () { return ""; }; - -/** - * Specifies the chart title with the specified parameters. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {string} sTitle - The title which will be displayed for the current chart. - * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the chart title is written in bold font or not. - */ -ApiChart.prototype.SetTitle = function (sTitle, nFontSize, bIsBold) {}; - -/** - * Specifies the chart horizontal axis title. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {string} sTitle - The title which will be displayed for the horizontal axis of the current chart. - * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the horizontal axis title is written in bold font or not. - * */ -ApiChart.prototype.SetHorAxisTitle = function (sTitle, nFontSize, bIsBold) {}; - -/** - * Specifies the chart vertical axis title. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {string} sTitle - The title which will be displayed for the vertical axis of the current chart. - * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the vertical axis title is written in bold font or not. - * */ -ApiChart.prototype.SetVerAxisTitle = function (sTitle, nFontSize, bIsBold) {}; - -/** - * Specifies the direction of the data displayed on the vertical axis. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {boolean} bIsMinMax - The true value sets the normal data direction for the vertical axis (from minimum to maximum). - * The false value sets the inverted data direction for the vertical axis (from maximum to minimum). - * */ -ApiChart.prototype.SetVerAxisOrientation = function (bIsMinMax) {}; - -/** - * Specifies the major tick mark for the horizontal axis. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetHorAxisMajorTickMark = function (sTickMark) {}; - -/** - * Specifies the minor tick mark for the horizontal axis. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetHorAxisMinorTickMark = function (sTickMark) {}; - -/** - * Specifies the major tick mark for the vertical axis. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetVertAxisMajorTickMark = function (sTickMark) {}; - -/** - * Specifies the minor tick mark for the vertical axis. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetVertAxisMinorTickMark = function (sTickMark) {}; - -/** - * Specifies the direction of the data displayed on the horizontal axis. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {boolean} bIsMinMax - The true value sets the normal data direction for the horizontal axis - * (from minimum to maximum). The false value sets the inverted data direction for the horizontal axis (from maximum to minimum). - * */ -ApiChart.prototype.SetHorAxisOrientation = function (bIsMinMax) {}; - -/** - * Specifies the chart legend position. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {"left" | "top" | "right" | "bottom" | "none"} sLegendPos - The position of the chart legend inside the chart window. - * */ -ApiChart.prototype.SetLegendPos = function (sLegendPos) {}; - -/** - * Specifies the legend font size. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {pt} nFontSize - The text size value measured in points. - * */ -ApiChart.prototype.SetLegendFontSize = function (nFontSize) {}; - -/** - * Specifies which chart data labels are shown for the chart. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. - * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. - * @param {boolean} bShowVal - Whether to show or hide the chart data values. - * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). - * */ -ApiChart.prototype.SetShowDataLabels = function (bShowSerName, bShowCatName, bShowVal, bShowPercent) {}; - -/** - * Spicifies the show options for the data labels. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {number} nSeriesIndex - The series index from the array of the data used to build the chart from. - * @param {number} nPointIndex - The point index from this series. - * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. - * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. - * @param {boolean} bShowVal - Whether to show or hide the chart data values. - * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). - * */ -ApiChart.prototype.SetShowPointDataLabel = function (nSeriesIndex, nPointIndex, bShowSerName, bShowCatName, bShowVal, bShowPercent) {}; - -/** - * Sets the possible values for the position of the chart tick labels in relation to the main vertical label or the chart data values. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart vertical tick labels. - * */ -ApiChart.prototype.SetVertAxisTickLabelPosition = function (sTickLabelPosition) {}; - -/** - * Sets the possible values for the position of the chart tick labels in relation to the main horizontal label or the chart data values. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart horizontal tick labels. - * */ -ApiChart.prototype.SetHorAxisTickLabelPosition = function (sTickLabelPosition) {}; - -/** - * Specifies the visual properties of the major vertical gridline. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMajorVerticalGridlines = function (oStroke) {}; - -/** - * Specifies the visual properties of the minor vertical gridline. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMinorVerticalGridlines = function (oStroke) {}; - -/** - * Specifies the visual properties of the major horizontal gridline. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMajorHorizontalGridlines = function (oStroke) {}; - -/** - * Specifies the visual properties of the minor vertical gridline. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - */ -ApiChart.prototype.SetMinorHorizontalGridlines = function (oStroke) {}; - -/** - * Specifies the font size to the horizontal axis labels. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {pt} nFontSize - The text size value measured in points. - */ -ApiChart.prototype.SetHorAxisLablesFontSize = function (nFontSize) {}; - -/** - * Specifies the font size to the vertical axis labels. - * @memberof ApiChart - * @typeofeditors ["CSE"] - * @param {pt} nFontSize - The text size value measured in points. - */ -ApiChart.prototype.SetVertAxisLablesFontSize = function (nFontSize) {}; - -/** - * Sets a style to the current chart by style ID. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param nStyleId - One of the styles available in the editor. - * @returns {boolean} - */ -ApiChart.prototype.ApplyChartStyle = function (nStyleId) { return true; }; - /** * Sets values from the specified range to the specified series. * @memberof ApiChart - * @typeofeditors ["CSE"] * @param {string} sRange - A range of cells from the sheet with series values. For example: - * * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, - * * "A1:A5" - must be a single cell, row or column, - * * "Example series". + * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, + * "A1:A5" - must be a single cell, row or column, + * "Example series". * @param {number} nSeria - The index of the chart series. * @returns {boolean} */ @@ -9380,11 +9685,10 @@ ApiChart.prototype.SetSeriaValues = function (sRange, nSeria) { return true; }; /** * Sets the x-axis values from the specified range to the specified series. It is used with the scatter charts only. * @memberof ApiChart - * @typeofeditors ["CSE"] * @param {string} sRange - A range of cells from the sheet with series x-axis values. For example: - * * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, - * * "A1:A5" - must be a single cell, row or column, - * * "Example series". + * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, + * "A1:A5" - must be a single cell, row or column, + * "Example series". * @param {number} nSeria - The index of the chart series. * @returns {boolean} */ @@ -9393,11 +9697,10 @@ ApiChart.prototype.SetSeriaXValues = function (sRange, nSeria) { return true; }; /** * Sets a name to the specified series. * @memberof ApiChart - * @typeofeditors ["CSE"] * @param {string} sNameRange - The series name. Can be a range of cells or usual text. For example: - * * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, - * * "A1:A5" - must be a single cell, row or column, - * * "Example series". + * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, + * "A1:A5" - must be a single cell, row or column, + * "Example series". * @param {number} nSeria - The index of the chart series. * @returns {boolean} */ @@ -9406,177 +9709,31 @@ ApiChart.prototype.SetSeriaName = function (sNameRange, nSeria) { return true; } /** * Sets a range with the category values to the current chart. * @memberof ApiChart - * @typeofeditors ["CSE"] * @param {string} sRange - A range of cells from the sheet with the category names. For example: - * * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, - * * "A1:A5" - must be a single cell, row or column. + * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, + * "A1:A5" - must be a single cell, row or column. */ ApiChart.prototype.SetCatFormula = function (sRange) {}; /** * Adds a new series to the current chart. * @memberof ApiChart - * @typeofeditors ["CSE"] * @param {string} sNameRange - The series name. Can be a range of cells or usual text. For example: - * * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, - * * "A1:A5" - must be a single cell, row or column, - * * "Example series". + * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, + * "A1:A5" - must be a single cell, row or column, + * "Example series". * @param {string} sValuesRange - A range of cells from the sheet with series values. For example: - * * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, - * * "A1:A5" - must be a single cell, row or column. + * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, + * "A1:A5" - must be a single cell, row or column. * @param {string} [sXValuesRange=undefined] - A range of cells from the sheet with series x-axis values. It is used with the scatter charts only. For example: - * * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, - * * "A1:A5" - must be a single cell, row or column. + * "'sheet 1'!$A$2:$A$5" - must be a single cell, row or column, + * "A1:A5" - must be a single cell, row or column. */ ApiChart.prototype.AddSeria = function (sNameRange, sValuesRange, sXValuesRange) {}; -/** - * Removes the specified series from the current chart. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {number} nSeria - The index of the chart series. - * @returns {boolean} - */ -ApiChart.prototype.RemoveSeria = function (nSeria) { return true; }; - -/** - * Sets the fill to the chart plot area. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the plot area. - * @returns {boolean} - */ -ApiChart.prototype.SetPlotAreaFill = function (oFill) { return true; }; - -/** - * Sets the outline to the chart plot area. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the plot area outline. - * @returns {boolean} - */ -ApiChart.prototype.SetPlotAreaOutLine = function (oStroke) { return true; }; - -/** - * Sets the fill to the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the series. - * @param {number} nSeries - The index of the chart series. - * @param {boolean} [bAll=false] - Specifies if the fill will be applied to all series. - * @returns {boolean} - */ -ApiChart.prototype.SetSeriesFill = function (oFill, nSeries, bAll) { return true; }; - -/** - * Sets the outline to the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the series outline. - * @param {number} nSeries - The index of the chart series. - * @param {boolean} [bAll=false] - Specifies if the outline will be applied to all series. - * @returns {boolean} - */ -ApiChart.prototype.SetSeriesOutLine = function (oStroke, nSeries, bAll) { return true; }; - -/** - * Sets the fill to the data point in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the data point. - * @param {number} nSeries - The index of the chart series. - * @param {number} nDataPoint - The index of the data point in the specified chart series. - * @param {boolean} [bAllSeries=false] - Specifies if the fill will be applied to the specified data point in all series. - * @returns {boolean} - */ -ApiChart.prototype.SetDataPointFill = function (oFill, nSeries, nDataPoint, bAllSeries) { return true; }; - -/** - * Sets the outline to the data point in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the data point outline. - * @param {number} nSeries - The index of the chart series. - * @param {number} nDataPoint - The index of the data point in the specified chart series. - * @param {boolean} bAllSeries - Specifies if the outline will be applied to the specified data point in all series. - * @returns {boolean} - */ -ApiChart.prototype.SetDataPointOutLine = function (oStroke, nSeries, nDataPoint, bAllSeries) { return true; }; - -/** - * Sets the fill to the marker in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the marker. - * @param {number} nSeries - The index of the chart series. - * @param {number} nMarker - The index of the marker in the specified chart series. - * @param {boolean} [bAllMarkers=false] - Specifies if the fill will be applied to all markers in the specified chart series. - * @returns {boolean} - */ -ApiChart.prototype.SetMarkerFill = function (oFill, nSeries, nMarker, bAllMarkers) { return true; }; - -/** - * Sets the outline to the marker in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the marker outline. - * @param {number} nSeries - The index of the chart series. - * @param {number} nMarker - The index of the marker in the specified chart series. - * @param {boolean} [bAllMarkers=false] - Specifies if the outline will be applied to all markers in the specified chart series. - * @returns {boolean} - */ -ApiChart.prototype.SetMarkerOutLine = function (oStroke, nSeries, nMarker, bAllMarkers) { return true; }; - -/** - * Sets the fill to the chart title. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the title. - * @returns {boolean} - */ -ApiChart.prototype.SetTitleFill = function (oFill) { return true; }; - -/** - * Sets the outline to the chart title. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the title outline. - * @returns {boolean} - */ -ApiChart.prototype.SetTitleOutLine = function (oStroke) { return true; }; - -/** - * Sets the fill to the chart legend. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the legend. - * @returns {boolean} - */ -ApiChart.prototype.SetLegendFill = function (oFill) { return true; }; - -/** - * Sets the outline to the chart legend. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the legend outline. - * @returns {boolean} - */ -ApiChart.prototype.SetLegendOutLine = function (oStroke) { return true; }; - -/** - * Sets the specified numeric format to the axis values. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {NumFormat | String} sFormat - Numeric format (can be custom format). - * @param {AxisPos} - Axis position. - * @returns {boolean} - */ -ApiChart.prototype.SetAxieNumFormat = function (sFormat, sAxiePos) { return true; }; - /** * Returns a type of the ApiOleObject class. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {"oleObject"} */ ApiOleObject.prototype.GetClassType = function () { return ""; }; @@ -9584,7 +9741,6 @@ ApiOleObject.prototype.GetClassType = function () { return ""; }; /** * Sets the data to the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {string} sData - The OLE object string data. * @returns {boolean} */ @@ -9593,7 +9749,6 @@ ApiOleObject.prototype.SetData = function (sData) { return true; }; /** * Returns the string data from the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiOleObject.prototype.GetData = function () { return ""; }; @@ -9601,7 +9756,6 @@ ApiOleObject.prototype.GetData = function () { return ""; }; /** * Sets the application ID to the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {string} sAppId - The application ID associated with the current OLE object. * @returns {boolean} */ @@ -9610,7 +9764,6 @@ ApiOleObject.prototype.SetApplicationId = function (sAppId) { return true; }; /** * Returns the application ID from the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiOleObject.prototype.GetApplicationId = function () { return ""; }; @@ -9618,7 +9771,6 @@ ApiOleObject.prototype.GetApplicationId = function () { return ""; }; /** * Returns a type of the ApiColor class. * @memberof ApiColor - * @typeofeditors ["CSE"] * @returns {"color"} */ ApiColor.prototype.GetClassType = function () { return ""; }; @@ -9626,7 +9778,6 @@ ApiColor.prototype.GetClassType = function () { return ""; }; /** * Returns a type of the ApiName class. * @memberof ApiName - * @typeofeditors ["CSE"] * @returns {string} */ ApiName.prototype.GetName = function () { return ""; }; @@ -9634,7 +9785,6 @@ ApiName.prototype.GetName = function () { return ""; }; /** * Sets a string value representing the object name. * @memberof ApiName - * @typeofeditors ["CSE"] * @param {string} sName - New name for the range. * @returns {boolean} - returns false if sName is invalid. */ @@ -9643,7 +9793,6 @@ ApiName.prototype.SetName = function (sName) { return true; }; /** * Sets a string value representing the object name. * @memberof ApiName - * @typeofeditors ["CSE"] * @param {string} sName - New name for the range. * @returns {boolean} - returns false if sName is invalid. */ @@ -9652,14 +9801,12 @@ ApiName.prototype.Name = ApiName.prototype.SetName (); /** * Deletes the DefName object. * @memberof ApiName - * @typeofeditors ["CSE"] */ ApiName.prototype.Delete = function () {}; /** * Sets a formula that the name is defined to refer to. * @memberof ApiName - * @typeofeditors ["CSE"] * @param {string} sRef - The range reference which must contain the sheet name, followed by sign ! and a range of cells. * Example: "Sheet1!$A$1:$B$2". */ @@ -9668,7 +9815,6 @@ ApiName.prototype.SetRefersTo = function (sRef) {}; /** * Returns a formula that the name is defined to refer to. * @memberof ApiName - * @typeofeditors ["CSE"] * @returns {string} */ ApiName.prototype.GetRefersTo = function () { return ""; }; @@ -9676,7 +9822,6 @@ ApiName.prototype.GetRefersTo = function () { return ""; }; /** * Returns a formula that the name is defined to refer to. * @memberof ApiName - * @typeofeditors ["CSE"] * @returns {string} */ ApiName.prototype.RefersTo = ApiName.prototype.GetRefersTo (); @@ -9684,7 +9829,6 @@ ApiName.prototype.RefersTo = ApiName.prototype.GetRefersTo (); /** * Returns the ApiRange object by its name. * @memberof ApiName - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiName.prototype.GetRefersToRange = function () { return new ApiRange(); }; @@ -9692,7 +9836,6 @@ ApiName.prototype.GetRefersToRange = function () { return new ApiRange(); }; /** * Returns the ApiRange object by its name. * @memberof ApiName - * @typeofeditors ["CSE"] * @returns {ApiRange} */ ApiName.prototype.RefersToRange = ApiName.prototype.GetRefersToRange (); @@ -9700,7 +9843,6 @@ ApiName.prototype.RefersToRange = ApiName.prototype.GetRefersToRange (); /** * Returns a type of the ApiComment class. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {"comment"} */ ApiComment.prototype.GetClassType = function () { return ""; }; @@ -9708,7 +9850,6 @@ ApiComment.prototype.GetClassType = function () { return ""; }; /** * Returns the comment text. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {string} */ ApiComment.prototype.GetText = function () { return ""; }; @@ -9716,7 +9857,6 @@ ApiComment.prototype.GetText = function () { return ""; }; /** * Sets the comment text. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {string} text - New text for comment. * @since 7.5.0 */ @@ -9725,7 +9865,6 @@ ApiComment.prototype.SetText = function (text) {}; /** * Sets the comment text. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {string} text - New text for comment. * @since 7.5.0 */ @@ -9734,7 +9873,6 @@ ApiComment.prototype.Text = ApiComment.prototype.SetText (); /** * Returns the current comment ID. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {string} * @since 7.5.0 */ @@ -9743,7 +9881,6 @@ ApiComment.prototype.GetId = function () { return ""; }; /** * Returns the current comment ID. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {string} * @since 7.5.0 */ @@ -9752,7 +9889,6 @@ ApiComment.prototype.Id = ApiComment.prototype.GetId (); /** * Returns the comment author's name. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {string} * @since 7.5.0 */ @@ -9761,7 +9897,6 @@ ApiComment.prototype.GetAuthorName = function () { return ""; }; /** * Sets the comment author's name. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {string} sAuthorName - The comment author's name. * @since 7.5.0 */ @@ -9770,7 +9905,6 @@ ApiComment.prototype.SetAuthorName = function (sAuthorName) {}; /** * Sets the comment author's name. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {string} sAuthorName - The comment author's name. * @since 7.5.0 */ @@ -9779,7 +9913,6 @@ ApiComment.prototype.AuthorName = ApiComment.prototype.SetAuthorName (); /** * Returns the user ID of the comment author. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {string} * @since 7.5.0 */ @@ -9788,7 +9921,6 @@ ApiComment.prototype.GetUserId = function () { return ""; }; /** * Sets the user ID to the comment author. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {string} sUserId - The user ID of the comment author. * @since 7.5.0 */ @@ -9797,7 +9929,6 @@ ApiComment.prototype.SetUserId = function (sUserId) {}; /** * Sets the user ID to the comment author. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {string} sUserId - The user ID of the comment author. * @since 7.5.0 */ @@ -9806,7 +9937,6 @@ ApiComment.prototype.UserId = ApiComment.prototype.SetUserId (); /** * Checks if a comment is solved or not. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {boolean} * @since 7.5.0 */ @@ -9815,7 +9945,6 @@ ApiComment.prototype.IsSolved = function () { return true; }; /** * Marks a comment as solved. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {boolean} bSolved - Specifies if a comment is solved or not. * @since 7.5.0 */ @@ -9824,7 +9953,6 @@ ApiComment.prototype.SetSolved = function (bSolved) {}; /** * Marks a comment as solved. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {boolean} bSolved - Specifies if a comment is solved or not. * @since 7.5.0 */ @@ -9833,7 +9961,6 @@ ApiComment.prototype.Solved = ApiComment.prototype.SetSolved (); /** * Returns the timestamp of the comment creation in UTC format. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {Number} * @since 7.5.0 */ @@ -9842,7 +9969,6 @@ ApiComment.prototype.GetTimeUTC = function () { return 0; }; /** * Sets the timestamp of the comment creation in UTC format. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment creation in UTC format. * @since 7.5.0 */ @@ -9851,7 +9977,6 @@ ApiComment.prototype.SetTimeUTC = function (timeStamp) {}; /** * Sets the timestamp of the comment creation in UTC format. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment creation in UTC format. * @since 7.5.0 */ @@ -9860,7 +9985,6 @@ ApiComment.prototype.TimeUTC = ApiComment.prototype.SetTimeUTC (); /** * Returns the timestamp of the comment creation in the current time zone format. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {Number} * @since 7.5.0 */ @@ -9869,7 +9993,6 @@ ApiComment.prototype.GetTime = function () { return 0; }; /** * Sets the timestamp of the comment creation in the current time zone format. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment creation in the current time zone format. * @since 7.5.0 */ @@ -9878,7 +10001,6 @@ ApiComment.prototype.SetTime = function (timeStamp) {}; /** * Sets the timestamp of the comment creation in the current time zone format. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment creation in the current time zone format. * @since 7.5.0 */ @@ -9887,7 +10009,6 @@ ApiComment.prototype.Time = ApiComment.prototype.SetTime (); /** * Returns the quote text of the current comment. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {String | null} * @since 7.5.0 */ @@ -9896,7 +10017,6 @@ ApiComment.prototype.GetQuoteText = function () { return ""; }; /** * Returns the quote text of the current comment. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {String | null} * @since 7.5.0 */ @@ -9905,7 +10025,6 @@ ApiComment.prototype.QuoteText = ApiComment.prototype.GetQuoteText (); /** * Returns a number of the comment replies. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {Number} * @since 7.5.0 */ @@ -9914,7 +10033,6 @@ ApiComment.prototype.GetRepliesCount = function () { return 0; }; /** * Returns a number of the comment replies. * @memberof ApiComment - * @typeofeditors ["CSE"] * @returns {Number} * @since 7.5.0 */ @@ -9923,7 +10041,6 @@ ApiComment.prototype.RepliesCount = ApiComment.prototype.GetRepliesCount (); /** * Returns the specified comment reply. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {Number} [nIndex = 0] - The comment reply index. * @returns {ApiCommentReply} * @since 7.5.0 @@ -9933,7 +10050,6 @@ ApiComment.prototype.GetReply = function (nIndex) { return new ApiCommentReply() /** * Adds a reply to a comment. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {String} sText - The comment reply text (required). * @param {String} sAuthorName - The name of the comment reply author (optional). * @param {String} sUserId - The user ID of the comment reply author (optional). @@ -9945,7 +10061,6 @@ ApiComment.prototype.AddReply = function (sText, sAuthorName, sUserId, nPos) {}; /** * Removes the specified comment replies. * @memberof ApiComment - * @typeofeditors ["CSE"] * @param {Number} [nPos = 0] - The position of the first comment reply to remove. * @param {Number} [nCount = 1] - A number of comment replies to remove. * @param {boolean} [bRemoveAll = false] - Specifies whether to remove all comment replies or not. @@ -9956,14 +10071,12 @@ ApiComment.prototype.RemoveReplies = function (nPos, nCount, bRemoveAll) {}; /** * Deletes the ApiComment object. * @memberof ApiComment - * @typeofeditors ["CSE"] */ ApiComment.prototype.Delete = function () {}; /** * Returns a type of the ApiCommentReply class. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @returns {"commentReply"} * @since 7.5.0 */ @@ -9972,7 +10085,6 @@ ApiCommentReply.prototype.GetClassType = function () { return ""; }; /** * Returns the comment reply text. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @returns {string} * @since 7.5.0 */ @@ -9981,7 +10093,6 @@ ApiCommentReply.prototype.GetText = function () { return ""; }; /** * Sets the comment reply text. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {string} sText - The comment reply text. * @since 7.5.0 */ @@ -9990,7 +10101,6 @@ ApiCommentReply.prototype.SetText = function (sText) {}; /** * Sets the comment reply text. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {string} sText - The comment reply text. * @since 7.5.0 */ @@ -9999,7 +10109,6 @@ ApiCommentReply.prototype.Text = ApiCommentReply.prototype.SetText (); /** * Returns the comment reply author's name. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @returns {string} * @since 7.5.0 */ @@ -10008,7 +10117,6 @@ ApiCommentReply.prototype.GetAuthorName = function () { return ""; }; /** * Sets the comment reply author's name. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {string} sAuthorName - The comment reply author's name. * @since 7.5.0 */ @@ -10017,7 +10125,6 @@ ApiCommentReply.prototype.SetAuthorName = function (sAuthorName) {}; /** * Sets the comment reply author's name. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {string} sAuthorName - The comment reply author's name. * @since 7.5.0 */ @@ -10026,7 +10133,6 @@ ApiCommentReply.prototype.AuthorName = ApiCommentReply.prototype.SetAuthorName ( /** * Returns the user ID of the comment reply author. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @returns {string} * @since 7.5.0 */ @@ -10035,7 +10141,6 @@ ApiCommentReply.prototype.GetUserId = function () { return ""; }; /** * Sets the user ID to the comment reply author. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {string} sUserId - The user ID of the comment reply author. * @since 7.5.0 */ @@ -10044,7 +10149,6 @@ ApiCommentReply.prototype.SetUserId = function (sUserId) {}; /** * Sets the user ID to the comment reply author. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {string} sUserId - The user ID of the comment reply author. * @since 7.5.0 */ @@ -10053,7 +10157,6 @@ ApiCommentReply.prototype.UserId = ApiCommentReply.prototype.SetUserId (); /** * Returns the timestamp of the comment reply creation in UTC format. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @returns {Number} * @since 7.5.0 */ @@ -10062,7 +10165,6 @@ ApiCommentReply.prototype.GetTimeUTC = function () { return 0; }; /** * Sets the timestamp of the comment reply creation in UTC format. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment reply creation in UTC format. * @since 7.5.0 */ @@ -10071,7 +10173,6 @@ ApiCommentReply.prototype.SetTimeUTC = function (timeStamp) {}; /** * Sets the timestamp of the comment reply creation in UTC format. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment reply creation in UTC format. * @since 7.5.0 */ @@ -10080,7 +10181,6 @@ ApiCommentReply.prototype.TimeUTC = ApiCommentReply.prototype.SetTimeUTC (); /** * Returns the timestamp of the comment reply creation in the current time zone format. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @returns {Number} * @since 7.5.0 */ @@ -10089,7 +10189,6 @@ ApiCommentReply.prototype.GetTime = function () { return 0; }; /** * Sets the timestamp of the comment reply creation in the current time zone format. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment reply creation in the current time zone format. * @since 7.5.0 */ @@ -10098,7 +10197,6 @@ ApiCommentReply.prototype.SetTime = function (timeStamp) {}; /** * Sets the timestamp of the comment reply creation in the current time zone format. * @memberof ApiCommentReply - * @typeofeditors ["CSE"] * @param {Number | String} nTimeStamp - The timestamp of the comment reply creation in the current time zone format. * @since 7.5.0 */ @@ -10107,7 +10205,6 @@ ApiCommentReply.prototype.Time = ApiCommentReply.prototype.SetTime (); /** * Returns a value that represents the number of objects in the collection. * @memberof ApiAreas - * @typeofeditors ["CSE"] * @returns {number} */ ApiAreas.prototype.GetCount = function () { return 0; }; @@ -10115,7 +10212,6 @@ ApiAreas.prototype.GetCount = function () { return 0; }; /** * Returns a value that represents the number of objects in the collection. * @memberof ApiAreas - * @typeofeditors ["CSE"] * @returns {number} */ ApiAreas.prototype.Count = ApiAreas.prototype.GetCount (); @@ -10123,7 +10219,6 @@ ApiAreas.prototype.Count = ApiAreas.prototype.GetCount (); /** * Returns a single object from a collection by its ID. * @memberof ApiAreas - * @typeofeditors ["CSE"] * @param {number} ind - The index number of the object. * @returns {ApiRange} */ @@ -10132,7 +10227,6 @@ ApiAreas.prototype.GetItem = function (ind) { return new ApiRange(); }; /** * Returns the parent object for the specified collection. * @memberof ApiAreas - * @typeofeditors ["CSE"] * @returns {number} */ ApiAreas.prototype.GetParent = function () { return 0; }; @@ -10140,7 +10234,6 @@ ApiAreas.prototype.GetParent = function () { return 0; }; /** * Returns the parent object for the specified collection. * @memberof ApiAreas - * @typeofeditors ["CSE"] * @returns {number} */ ApiAreas.prototype.Parent = ApiAreas.prototype.GetParent (); @@ -10148,7 +10241,6 @@ ApiAreas.prototype.Parent = ApiAreas.prototype.GetParent (); /** * Returns a value that represents a number of objects in the collection. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {number} * @since 7.4.0 */ @@ -10157,7 +10249,6 @@ ApiCharacters.prototype.GetCount = function () { return 0; }; /** * Returns a value that represents a number of objects in the collection. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {number} * @since 7.4.0 */ @@ -10166,7 +10257,6 @@ ApiCharacters.prototype.Count = ApiCharacters.prototype.GetCount (); /** * Returns the parent object of the specified characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {ApiRange} * @since 7.4.0 */ @@ -10175,7 +10265,6 @@ ApiCharacters.prototype.GetParent = function () { return new ApiRange(); }; /** * Returns the parent object of the specified characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {ApiRange} * @since 7.4.0 */ @@ -10184,7 +10273,6 @@ ApiCharacters.prototype.Parent = ApiCharacters.prototype.GetParent (); /** * Deletes the ApiCharacters object. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @since 7.4.0 */ ApiCharacters.prototype.Delete = function () {}; @@ -10192,7 +10280,6 @@ ApiCharacters.prototype.Delete = function () {}; /** * Inserts a string replacing the specified characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @param {string} String - The string to insert. * @since 7.4.0 */ @@ -10201,7 +10288,6 @@ ApiCharacters.prototype.Insert = function (String) {}; /** * Sets a string value that represents the text of the specified range of characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @param {string} Caption - A string value that represents the text of the specified range of characters. * @since 7.4.0 */ @@ -10210,7 +10296,6 @@ ApiCharacters.prototype.SetCaption = function (Caption) {}; /** * Returns a string value that represents the text of the specified range of characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {string} - A string value that represents the text of the specified range of characters. * @since 7.4.0 */ @@ -10219,7 +10304,6 @@ ApiCharacters.prototype.GetCaption = function () { return ""; }; /** * Returns a string value that represents the text of the specified range of characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {string} - A string value that represents the text of the specified range of characters. * @since 7.4.0 */ @@ -10228,7 +10312,6 @@ ApiCharacters.prototype.Caption = ApiCharacters.prototype.GetCaption (); /** * Sets the text for the specified characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @param {string} Text - The text to be set. * @since 7.4.0 */ @@ -10237,7 +10320,6 @@ ApiCharacters.prototype.SetText = function (Text) {}; /** * Returns the text of the specified range of characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {string} - The text of the specified range of characters. * @since 7.4.0 */ @@ -10246,7 +10328,6 @@ ApiCharacters.prototype.GetText = function () { return ""; }; /** * Returns the text of the specified range of characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {string} - The text of the specified range of characters. * @since 7.4.0 */ @@ -10255,7 +10336,6 @@ ApiCharacters.prototype.Text = ApiCharacters.prototype.GetText (); /** * Returns the ApiFont object that represents the font of the specified characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {ApiFont} * @since 7.4.0 */ @@ -10264,7 +10344,6 @@ ApiCharacters.prototype.GetFont = function () { return new ApiFont(); }; /** * Returns the ApiFont object that represents the font of the specified characters. * @memberof ApiCharacters - * @typeofeditors ["CSE"] * @returns {ApiFont} * @since 7.4.0 */ @@ -10273,7 +10352,6 @@ ApiCharacters.prototype.Font = ApiCharacters.prototype.GetFont (); /** * Returns the parent ApiCharacters object of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {ApiCharacters} - The parent ApiCharacters object. * @since 7.4.0 */ @@ -10282,7 +10360,6 @@ ApiFont.prototype.GetParent = function () { return new ApiCharacters(); }; /** * Returns the parent ApiCharacters object of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {ApiCharacters} - The parent ApiCharacters object. * @since 7.4.0 */ @@ -10291,7 +10368,6 @@ ApiFont.prototype.Parent = ApiFont.prototype.GetParent (); /** * Returns the bold property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {boolean | null} * @since 7.4.0 */ @@ -10301,7 +10377,6 @@ ApiFont.prototype.GetBold = function () { return true; }; * Sets the bold property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isBold - Specifies that the text characters are displayed bold. * @since 7.4.0 */ @@ -10311,7 +10386,6 @@ ApiFont.prototype.SetBold = function (isBold) {}; * Sets the bold property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isBold - Specifies that the text characters are displayed bold. * @since 7.4.0 */ @@ -10320,7 +10394,6 @@ ApiFont.prototype.Bold = ApiFont.prototype.SetBold (); /** * Returns the italic property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {boolean | null} * @since 7.4.0 */ @@ -10330,7 +10403,6 @@ ApiFont.prototype.GetItalic = function () { return true; }; * Sets the italic property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isItalic - Specifies that the text characters are displayed italic. * @since 7.4.0 */ @@ -10340,7 +10412,6 @@ ApiFont.prototype.SetItalic = function (isItalic) {}; * Sets the italic property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isItalic - Specifies that the text characters are displayed italic. * @since 7.4.0 */ @@ -10349,7 +10420,6 @@ ApiFont.prototype.Italic = ApiFont.prototype.SetItalic (); /** * Returns the font size property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {number | null} * @since 7.4.0 */ @@ -10359,7 +10429,6 @@ ApiFont.prototype.GetSize = function () { return 0; }; * Sets the font size property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {number} Size - Font size. * @since 7.4.0 */ @@ -10369,7 +10438,6 @@ ApiFont.prototype.SetSize = function (Size) {}; * Sets the font size property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {number} Size - Font size. * @since 7.4.0 */ @@ -10378,7 +10446,6 @@ ApiFont.prototype.Size = ApiFont.prototype.SetSize (); /** * Returns the strikethrough property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {boolean | null} * @since 7.4.0 */ @@ -10388,7 +10455,6 @@ ApiFont.prototype.GetStrikethrough = function () { return true; }; * Sets the strikethrough property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isStrikethrough - Specifies that the text characters are displayed strikethrough. * @since 7.4.0 */ @@ -10398,7 +10464,6 @@ ApiFont.prototype.SetStrikethrough = function (isStrikethrough) {}; * Sets the strikethrough property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isStrikethrough - Specifies that the text characters are displayed strikethrough. * @since 7.4.0 */ @@ -10412,7 +10477,6 @@ ApiFont.prototype.Strikethrough = ApiFont.prototype.SetStrikethrough (); /** * Returns the type of underline applied to the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {XlUnderlineStyle | null} * @since 7.4.0 */ @@ -10422,7 +10486,6 @@ ApiFont.prototype.GetUnderline = function () { return new XlUnderlineStyle(); }; * Sets an underline of the type specified in the request to the current font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {XlUnderlineStyle} Underline - Underline type. * @since 7.4.0 */ @@ -10432,7 +10495,6 @@ ApiFont.prototype.SetUnderline = function (Underline) {}; * Sets an underline of the type specified in the request to the current font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {XlUnderlineStyle} Underline - Underline type. * @since 7.4.0 */ @@ -10441,7 +10503,6 @@ ApiFont.prototype.Underline = ApiFont.prototype.SetUnderline (); /** * Returns the subscript property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {boolean | null} * @since 7.4.0 */ @@ -10451,7 +10512,6 @@ ApiFont.prototype.GetSubscript = function () { return true; }; * Sets the subscript property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isSubscript - Specifies that the text characters are displayed subscript. * @since 7.4.0 */ @@ -10461,7 +10521,6 @@ ApiFont.prototype.SetSubscript = function (isSubscript) {}; * Sets the subscript property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isSubscript - Specifies that the text characters are displayed subscript. * @since 7.4.0 */ @@ -10470,7 +10529,6 @@ ApiFont.prototype.Subscript = ApiFont.prototype.SetSubscript (); /** * Returns the superscript property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {boolean | null} * @since 7.4.0 */ @@ -10480,7 +10538,6 @@ ApiFont.prototype.GetSuperscript = function () { return true; }; * Sets the superscript property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isSuperscript - Specifies that the text characters are displayed superscript. * @since 7.4.0 */ @@ -10490,7 +10547,6 @@ ApiFont.prototype.SetSuperscript = function (isSuperscript) {}; * Sets the superscript property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {boolean} isSuperscript - Specifies that the text characters are displayed superscript. * @since 7.4.0 */ @@ -10499,7 +10555,6 @@ ApiFont.prototype.Superscript = ApiFont.prototype.SetSuperscript (); /** * Returns the font name property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {string | null} * @since 7.4.0 */ @@ -10509,7 +10564,6 @@ ApiFont.prototype.GetName = function () { return ""; }; * Sets the font name property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {string} FontName - Font name. * @since 7.4.0 */ @@ -10519,7 +10573,6 @@ ApiFont.prototype.SetName = function (FontName) {}; * Sets the font name property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {string} FontName - Font name. * @since 7.4.0 */ @@ -10528,7 +10581,6 @@ ApiFont.prototype.Name = ApiFont.prototype.SetName (); /** * Returns the font color property of the specified font. * @memberof ApiFont - * @typeofeditors ["CSE"] * @returns {ApiColor | null} * @since 7.4.0 */ @@ -10538,7 +10590,6 @@ ApiFont.prototype.GetColor = function () { return new ApiColor(); }; * Sets the font color property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {ApiColor} Color - Font color. * @since 7.4.0 */ @@ -10548,7 +10599,6 @@ ApiFont.prototype.SetColor = function (Color) {}; * Sets the font color property to the specified font. * This method will work only with the text format of the cell. * @memberof ApiFont - * @typeofeditors ["CSE"] * @param {ApiColor} Color - Font color. * @since 7.4.0 */ @@ -10557,7 +10607,6 @@ ApiFont.prototype.Color = ApiFont.prototype.SetColor (); /** * Sets the frozen cells in the active worksheet view. The range provided corresponds to the cells that will be frozen in the top- and left-most pane. * @memberof ApiFreezePanes - * @typeofeditors ["CSE"] * @param {ApiRange | String} frozenRange - A range that represents the cells to be frozen. * @since 8.0.0 */ @@ -10566,7 +10615,6 @@ ApiFreezePanes.prototype.FreezeAt = function (frozenRange) {}; /** * Freezes the first column or columns of the current worksheet. * @memberof ApiFreezePanes - * @typeofeditors ["CSE"] * @param {Number} [count=0] - Optional number of columns to freeze, or zero to unfreeze all columns. * @since 8.0.0 */ @@ -10575,7 +10623,6 @@ ApiFreezePanes.prototype.FreezeColumns = function (count) {}; /** * Freezes the top row or rows of the current worksheet. * @memberof ApiFreezePanes - * @typeofeditors ["CSE"] * @param {Number} [count=0] - Optional number of rows to freeze, or zero to unfreeze all rows. * @since 8.0.0 */ @@ -10584,12 +10631,18 @@ ApiFreezePanes.prototype.FreezeRows = function (count) {}; /** * Returns a range that describes the frozen cells in the active worksheet view. * @memberof ApiFreezePanes - * @typeofeditors ["CSE"] * @returns {ApiRange | null} - Returns null if there is no frozen pane. * @since 8.0.0 */ ApiFreezePanes.prototype.GetLocation = function () { return new ApiRange(); }; +/** + * Removes all frozen panes in the current worksheet. + * @memberof ApiFreezePanes + * @since 8.0.0 + */ +ApiFreezePanes.prototype.Unfreeze = function () {}; + /** * Class representing a user-protected range. * @constructor @@ -10599,7 +10652,6 @@ function ApiProtectedRange(protectedRange) {} /** * Sets a title to the current protected range. * @memberof ApiProtectedRange - * @typeofeditors ["CSE"] * @param {string} sTitle - The title which will be displayed for the current protected range. * @returns {boolean} - Returns false if a user doesn't have permission to modify the protected range. * @since 8.1.0 @@ -10609,7 +10661,6 @@ ApiProtectedRange.prototype.SetTitle = function (sTitle) { return true; }; /** * Sets a range to the current protected range. * @memberof ApiProtectedRange - * @typeofeditors ["CSE"] * @param {string} sRange - The cell range which will be set for the current protected range. * @returns {boolean} - Returns false if a user doesn't have permission to modify the protected range. * @since 8.1.0 @@ -10624,7 +10675,6 @@ ApiProtectedRange.prototype.SetRange = function (sRange) { return true; }; /** * Sets a user to the current protected range. * @memberof ApiProtectedRange - * @typeofeditors ["CSE"] * @param {string} sId - The user ID. * @param {string} sName - The user name. * @param {ProtectedRangeUserType} protectedRangeUserType - The user type of the protected range. @@ -10637,7 +10687,7 @@ ApiProtectedRange.prototype.AddUser = function (sId, sName, protectedRangeUserTy * Removes a user from the current protected range. * @memberof ApiProtectedRange * @param {string} sId - The user ID. - * @returns {bool} + * @returns {boolean} * @since 8.1.0 */ ApiProtectedRange.prototype.DeleteUser = function (sId) { return true; }; @@ -10645,7 +10695,6 @@ ApiProtectedRange.prototype.DeleteUser = function (sId) { return true; }; /** * Returns all users from the current protected range. * @memberof ApiProtectedRange - * @typeofeditors ["CSE"] * @returns {ApiProtectedRangeUserInfo[] | null} * @since 8.1.0 */ @@ -10654,9 +10703,8 @@ ApiProtectedRange.prototype.GetAllUsers = function () { return [new ApiProtected /** * Sets the type of the "Anyone" user to the current protected range. * @memberof ApiProtectedRange - * @typeofeditors ["CSE"] * @param {ProtectedRangeUserType} protectedRangeUserType - The user type of the protected range. - * @returns {bool} + * @returns {boolean} * @since 8.1.0 */ ApiProtectedRange.prototype.SetAnyoneType = function (protectedRangeUserType) { return true; }; @@ -10679,7 +10727,6 @@ function ApiProtectedRangeUserInfo(userInfo, protectedRange) {} /** * Returns the name property of the current user's information. * @memberof ApiProtectedRangeUserInfo - * @typeofeditors ["CSE"] * @returns {string | null} * @since 8.1.0 */ @@ -10688,7 +10735,6 @@ ApiProtectedRangeUserInfo.prototype.GetName = function () { return ""; }; /** * Returns the type property of the current user's information. * @memberof ApiProtectedRangeUserInfo - * @typeofeditors ["CSE"] * @returns {ProtectedRangeUserType} * @since 8.1.0 */ @@ -10697,10 +10743,1704 @@ ApiProtectedRangeUserInfo.prototype.GetType = function () { return new Protected /** * Returns the ID property of the current user's information. * @memberof ApiProtectedRangeUserInfo - * @typeofeditors ["CSE"] * @returns {string | null} * @since 8.1.0 */ ApiProtectedRangeUserInfo.prototype.GetId = function () { return ""; }; +/** + * Adds a data field to the pivot table report. + * @memberof ApiPivotTable + * @param {number | string} field - The index number or name of the data field. + * @returns {ApiPivotDataField} + * @since 8.2.0 + */ +ApiPivotTable.prototype.AddDataField = function (field) { return new ApiPivotDataField(); }; + +/** + * Adds the row, column, and page fields to the pivot table report. + * @memberof ApiPivotTable + * @param {PivotTableFieldOptions} options - The settings for adding row, column, and page fields to the pivot table report. + * @since 8.2.0 + */ +ApiPivotTable.prototype.AddFields = function (options) {}; + +/** + * Deletes all filters currently applied to the pivot table. + * @memberof ApiPivotTable + * @since 8.2.0 + */ +ApiPivotTable.prototype.ClearAllFilters = function () {}; + +/** + * Clears the pivot table. + * @memberof ApiPivotTable + * @since 8.2.0 + */ +ApiPivotTable.prototype.ClearTable = function () {}; + +/** + * Returns the value for the data field in a pivot table. + * @memberof ApiPivotTable + * @param {string[]} items - Describes a single cell in the pivot table report. + * For example, "'Estimated Costs' Tables May", which shows the estimated costs for tables in May + * (Data field = Costs, Product = Tables, Month = May). + * @returns {number | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetData = function (items) { return 0; }; + +/** + * Returns a Range object with information about a data item in the pivot table report. + * @memberof ApiPivotTable + * @param {string} [dataField] - The name of the field containing the data for the PivotTable. + * @param {string[]} [fieldItemsArray] - An array of field items from the pivot table. + * @returns {ApiRange} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetPivotData = function (dataField, fieldItemsArray) { return new ApiRange(); }; + +/** + * Returns a collection that represents either a single pivot table field + * or a collection of both the visible and hidden fields in the pivot table report. + * @memberof ApiPivotTable + * @param {string | number} [field] - The name or index of the field to be returned. + * @returns {ApiPivotField[] | ApiPivotField | ApiPivotDataField | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetPivotFields = function (field) { return [new ApiPivotField()]; }; + +/** + * Returns a collection that represents either a single pivot table field + * or a collection of both the visible and hidden fields in the pivot table report. + * @memberof ApiPivotTable + * @param {string | number} [field] - The name or index of the field to be returned. + * @returns {ApiPivotField[] | ApiPivotField | ApiPivotDataField | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.PivotFields = ApiPivotTable.prototype.GetPivotFields (); + +/** + * Returns the value of a pivot table cell. + * @memberof ApiPivotTable + * @param {number} rowLine - The position of the pivot line (a line of rows in the pivot table) on the row area. + * @param {number} colLine - The position of the pivot line (a line of columns in the pivot table) on the column area. + * @returns {number | string | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.PivotValueCell = function (rowLine, colLine) { return 0; }; + +/** + * Shows details of the pivot table cell. + * @memberof ApiPivotTable + * @param {number} rowLine - The position of the pivot line (a line of rows in the pivot table) on the row area. + * @param {number} colLine - The position of the pivot line (a line of columns in the pivot table) on the column area. + * @returns {boolean} - Returns true if the operation is successful. + * @since 8.2.0 + */ +ApiPivotTable.prototype.ShowDetails = function (rowLine, colLine) { return true; }; + +/** + * Refreshes the pivot table report from the source data. + * @memberof ApiPivotTable + * @since 8.2.0 + */ +ApiPivotTable.prototype.RefreshTable = function () {}; + +/** + * Updates the current pivot table. + * @memberof ApiPivotTable + * @since 8.2.0 + */ +ApiPivotTable.prototype.Update = function () {}; + +/** + * Specifies whether to repeat item labels for all pivot fields in the specified pivot table. + * @memberof ApiPivotTable + * @param {boolean} repeat - Specifies whether to repeat all field item labels in a pivot table report. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetRepeatAllLabels = function (repeat) {}; + +/** + * Specifies whether to repeat item labels for all pivot fields in the specified pivot table. + * @memberof ApiPivotTable + * @param {boolean} repeat - Specifies whether to repeat all field item labels in a pivot table report. + * @since 8.2.0 + */ +ApiPivotTable.prototype.RepeatAllLabels = ApiPivotTable.prototype.SetRepeatAllLabels (); + +/** + * Sets the way the specified pivot table items appear — in table format or in outline format. + * @memberof ApiPivotTable + * @param {PivotLayoutType} type - The layout type of the pivot table report. + * @param {boolean} compact - Specifies whether the pivot table items will be displayed in the compact form. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetRowAxisLayout = function (type, compact) {}; + +/** + * Sets the way the specified pivot table items appear — in table format or in outline format. + * @memberof ApiPivotTable + * @param {PivotLayoutType} type - The layout type of the pivot table report. + * @param {boolean} compact - Specifies whether the pivot table items will be displayed in the compact form. + * @since 8.2.0 + */ +ApiPivotTable.prototype.RowAxisLayout = ApiPivotTable.prototype.SetRowAxisLayout (); + +/** + * The type of the pivot table subtotal layout. + * @typedef { "Hidden" | "Top" | "Bottom" } PivotSubtotalLayoutType + */ + +/** + * Sets the layout subtotal location in the pivot table. + * @memberof ApiPivotTable + * @param {PivotSubtotalLayoutType} type - The type of the pivot table subtotal layout. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetSubtotalLocation = function (type) {}; + +/** + * Sets the layout subtotal location in the pivot table. + * @memberof ApiPivotTable + * @param {PivotSubtotalLayoutType} type - The type of the pivot table subtotal layout. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SubtotalLocation = ApiPivotTable.prototype.SetSubtotalLocation (); + +/** + * Removes the specified field from all the pivot table categories. + * @memberof ApiPivotTable + * @param {number | string} identifier - The index number or name of the field. + * @since 8.2.0 + */ +ApiPivotTable.prototype.RemoveField = function (identifier) {}; + +/** + * The direction to move the pivot table field. + * @typedef { "Up" | "Down" | "Begin" | "End" } PivotMoveFieldType + */ + +/** + * The pivot field orientation type. + * @typedef {"Rows" | "Columns" | "Filters" | "Values" | "Hidden" } PivotFieldOrientationType + */ + +/** + * Moves the specified field from one category to another. + * @memberof ApiPivotTable + * @param {number | string} identifier - The index number or name of the field. + * @param {PivotMoveFieldType | PivotFieldOrientationType} type - The direction to move the pivot table field, + * or the pivot field orientation type. + * @param {number} [index] - The field index in a new category. + * @since 8.2.0 + */ +ApiPivotTable.prototype.MoveField = function (identifier, type, index) {}; + +/** + * Selects the current pivot table. + * @memberof ApiPivotTable + * @since 8.2.0 + */ +ApiPivotTable.prototype.Select = function () {}; + +/** + * Returns a collection that is currently displayed as column fields in the pivot table. + * @memberof ApiPivotTable + * @param {number | string | undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetColumnFields = function (field) { return [new ApiPivotField()]; }; + +/** + * Returns a collection that is currently displayed as column fields in the pivot table. + * @memberof ApiPivotTable + * @param {number | string | undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.ColumnFields = ApiPivotTable.prototype.GetColumnFields (); + +/** + * Returns a collection that represents either a single pivot table data field + * or a collection of all visible data fields. + * @memberof ApiPivotTable + * @param {number | string |undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotDataField[] | ApiPivotDataField | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetDataFields = function (field) { return [new ApiPivotDataField()]; }; + +/** + * Returns a collection that represents either a single pivot table data field + * or a collection of all visible data fields. + * @memberof ApiPivotTable + * @param {number | string |undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotDataField[] | ApiPivotDataField | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.DataFields = ApiPivotTable.prototype.GetDataFields (); + +/** + * Returns an array that represents all the hidden fields in the pivot table. + * @memberof ApiPivotTable + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetHiddenFields = function () { return [new ApiPivotField()]; }; + +/** + * Returns an array that represents all the hidden fields in the pivot table. + * @memberof ApiPivotTable + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.HiddenFields = ApiPivotTable.prototype.GetHiddenFields (); + +/** + * Returns an array that represents all the visible fields in the pivot table. + * @memberof ApiPivotTable + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetVisibleFields = function () { return [new ApiPivotField()]; }; + +/** + * Returns an array that represents all the visible fields in the pivot table. + * @memberof ApiPivotTable + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.VisibleFields = ApiPivotTable.prototype.GetVisibleFields (); + +/** + * Returns a collection that represents either a single pivot table page field + * or a collection of all visible page fields. + * @memberof ApiPivotTable + * @param {number | string |undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetPageFields = function (field) { return [new ApiPivotField()]; }; + +/** + * Returns a collection that represents either a single pivot table page field + * or a collection of all visible page fields. + * @memberof ApiPivotTable + * @param {number | string |undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.PageFields = ApiPivotTable.prototype.GetPageFields (); + +/** + * Returns a collection that is currently displayed as row fields in the pivot table. + * @memberof ApiPivotTable + * @param {number | string |undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetRowFields = function (field) { return [new ApiPivotField()]; }; + +/** + * Returns a collection that is currently displayed as row fields in the pivot table. + * @memberof ApiPivotTable + * @param {number | string |undefined} field - The name or index of the field to be returned. + * @returns {ApiPivotField[]} + * @since 8.2.0 + */ +ApiPivotTable.prototype.RowFields = ApiPivotTable.prototype.GetRowFields (); + +/** + * Returns the pivot table name. + * @memberof ApiPivotTable + * @returns {string} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetName = function () { return ""; }; + +/** + * Sets the pivot table name. + * @memberof ApiPivotTable + * @param {string} name - The pivot table name. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetName = function (name) {}; + +/** + * Sets the pivot table name. + * @memberof ApiPivotTable + * @param {string} name - The pivot table name. + * @since 8.2.0 + */ +ApiPivotTable.prototype.Name = ApiPivotTable.prototype.SetName (); + +/** + * Returns the Grand Totals setting of the pivot table columns. + * @memberof ApiPivotTable + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetColumnGrand = function () { return true; }; + +/** + * Sets the Grand Totals setting to the pivot table columns. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to display the grand totals for columns. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetColumnGrand = function (show) {}; + +/** + * Sets the Grand Totals setting to the pivot table columns. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to display the grand totals for columns. + * @since 8.2.0 + */ +ApiPivotTable.prototype.ColumnGrand = ApiPivotTable.prototype.SetColumnGrand (); + +/** + * Returns the Grand Totals setting of the pivot table rows. + * @memberof ApiPivotTable + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetRowGrand = function () { return true; }; + +/** + * Sets the Grand Totals setting to the pivot table rows. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to display the grand totals for rows. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetRowGrand = function (show) {}; + +/** + * Sets the Grand Totals setting to the pivot table rows. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to display the grand totals for rows. + * @since 8.2.0 + */ +ApiPivotTable.prototype.RowGrand = ApiPivotTable.prototype.SetRowGrand (); + +/** + * Specifies how the report filter fields are located. + * @typedef {"OverThenDown" | "DownThenOver"} FieldsInReportFilterType + */ + +/** + * Returns the pivot table display fields in the report filter area settings. + * @memberof ApiPivotTable + * @returns {PivotTableFilterAreaInfo} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetDisplayFieldsInReportFilterArea = function () { return new PivotTableFilterAreaInfo(); }; + +/** + * Sets the pivot table display fields in the report filter area settings. + * @memberof ApiPivotTable + * @param {FieldsInReportFilterType} type - Specifies how the report filter fields are located. + * @param {number} fields - A number of the report filter fields. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetDisplayFieldsInReportFilterArea = function (type, fields) {}; + +/** + * Returns the setting which specifies whether to display field headers for rows and columns. + * @memberof ApiPivotTable + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetDisplayFieldCaptions = function () { return true; }; + +/** + * Returns the setting which specifies whether to display field headers for rows and columns. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to display field headers for rows and columns. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetDisplayFieldCaptions = function (show) {}; + +/** + * Returns the setting which specifies whether to display field headers for rows and columns. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to display field headers for rows and columns. + * @since 8.2.0 + */ +ApiPivotTable.prototype.DisplayFieldCaptions = ApiPivotTable.prototype.SetDisplayFieldCaptions (); + +/** + * Returns the pivot table title. + * @memberof ApiPivotTable + * @returns {string} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetTitle = function () { return ""; }; + +/** + * Sets the pivot table title. + * @memberof ApiPivotTable + * @param {string} title - The pivot table title. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetTitle = function (title) {}; + +/** + * Sets the pivot table title. + * @memberof ApiPivotTable + * @param {string} title - The pivot table title. + * @since 8.2.0 + */ +ApiPivotTable.prototype.Title = ApiPivotTable.prototype.SetTitle (); + +/** + * Returns the pivot table description. + * @memberof ApiPivotTable + * @returns {string} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetDescription = function () { return ""; }; + +/** + * Sets the pivot table description. + * @memberof ApiPivotTable + * @param {string} description - The pivot table description. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetDescription = function (description) {}; + +/** + * Sets the pivot table description. + * @memberof ApiPivotTable + * @param {string} description - The pivot table description. + * @since 8.2.0 + */ +ApiPivotTable.prototype.Description = ApiPivotTable.prototype.SetDescription (); + +/** + * Returns the pivot table style name. + * @memberof ApiPivotTable + * @returns {string} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetStyleName = function () { return ""; }; + +/** + * Sets the pivot table style name. + * @memberof ApiPivotTable + * @param {string} name - The pivot table style name. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetStyleName = function (name) {}; + +/** + * Sets the pivot table style name. + * @memberof ApiPivotTable + * @param {string} name - The pivot table style name. + * @since 8.2.0 + */ +ApiPivotTable.prototype.StyleName = ApiPivotTable.prototype.SetStyleName (); + +/** + * Returns the setting which specifies whether the row headers of the pivot table will be highlighted with the special formatting. + * @memberof ApiPivotTable + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetTableStyleRowHeaders = function () { return true; }; + +/** + * Sets the setting which specifies whether the row headers of the pivot table will be highlighted with the special formatting. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the row headers of the pivot table will be highlighted with the special formatting. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetTableStyleRowHeaders = function (show) {}; + +/** + * Sets the setting which specifies whether the row headers of the pivot table will be highlighted with the special formatting. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the row headers of the pivot table will be highlighted with the special formatting. + * @since 8.2.0 + */ +ApiPivotTable.prototype.ShowTableStyleRowHeaders = ApiPivotTable.prototype.SetTableStyleRowHeaders (); + +/** + * Returns the setting which specifies whether the column headers of the pivot table will be highlighted with the special formatting. + * @memberof ApiPivotTable + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetTableStyleColumnHeaders = function () { return true; }; + +/** + * Sets the setting which specifies whether the column headers of the pivot table will be highlighted with the special formatting. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the column headers of the pivot table will be highlighted with the special formatting. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetTableStyleColumnHeaders = function (show) {}; + +/** + * Sets the setting which specifies whether the column headers of the pivot table will be highlighted with the special formatting. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the column headers of the pivot table will be highlighted with the special formatting. + * @since 8.2.0 + */ +ApiPivotTable.prototype.ShowTableStyleColumnHeaders = ApiPivotTable.prototype.SetTableStyleColumnHeaders (); + +/** + * Returns the setting which specifies whether the background color alternation for odd and even rows will be enabled for the pivot table. + * @memberof ApiPivotTable + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetTableStyleRowStripes = function () { return true; }; + +/** + * Sets the setting which specifies whether the background color alternation for odd and even rows will be enabled for the pivot table. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the background color alternation for odd and even rows will be enabled for the pivot table. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetTableStyleRowStripes = function (show) {}; + +/** + * Sets the setting which specifies whether the background color alternation for odd and even rows will be enabled for the pivot table. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the background color alternation for odd and even rows will be enabled for the pivot table. + * @since 8.2.0 + */ +ApiPivotTable.prototype.ShowTableStyleRowStripes = ApiPivotTable.prototype.SetTableStyleRowStripes (); + +/** + * Returns the setting which specifies whether the background color alternation for odd and even columns will be enabled for the pivot table. + * @memberof ApiPivotTable + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetTableStyleColumnStripes = function () { return true; }; + +/** + * Sets the setting which specifies whether the background color alternation for odd and even columns will be enabled for the pivot table. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the background color alternation for odd and even columns will be enabled for the pivot table. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetTableStyleColumnStripes = function (show) {}; + +/** + * Sets the setting which specifies whether the background color alternation for odd and even columns will be enabled for the pivot table. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether the background color alternation for odd and even columns will be enabled for the pivot table. + * @since 8.2.0 + */ +ApiPivotTable.prototype.ShowTableStyleColumnStripes = ApiPivotTable.prototype.SetTableStyleColumnStripes (); + +/** + * Returns the source range for the pivot table. + * @memberof ApiPivotTable + * @returns {ApiRange} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetSource = function () { return new ApiRange(); }; + +/** + * Sets the source range for the pivot table. + * @memberof ApiPivotTable + * @param {ApiRange} source - The range where the pivot table will be located. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetSource = function (source) {}; + +/** + * Sets the source range for the pivot table. + * @memberof ApiPivotTable + * @param {ApiRange} source - The range where the pivot table will be located. + * @since 8.2.0 + */ +ApiPivotTable.prototype.Source = ApiPivotTable.prototype.SetSource (); + +/** + * Returns a Range object that represents the column area in the pivot table report. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetColumnRange = function () { return new ApiRange(); }; + +/** + * Returns a Range object that represents the column area in the pivot table report. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.ColumnRange = ApiPivotTable.prototype.GetColumnRange (); + +/** + * Returns a Range object that represents the row area in the pivot table report. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetRowRange = function () { return new ApiRange(); }; + +/** + * Returns a Range object that represents the row area in the pivot table report. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.RowRange = ApiPivotTable.prototype.GetRowRange (); + +/** + * Returns a Range object that represents the range of values in the pivot table. + * @memberof ApiPivotTable + * @returns {ApiRange} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetDataBodyRange = function () { return new ApiRange(); }; + +/** + * Returns a Range object that represents the range of values in the pivot table. + * @memberof ApiPivotTable + * @returns {ApiRange} + * @since 8.2.0 + */ +ApiPivotTable.prototype.DataBodyRange = ApiPivotTable.prototype.GetDataBodyRange (); + +/** + * Returns a Range object that represents the entire pivot table report, but doesn't include page fields. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetTableRange1 = function () { return new ApiRange(); }; + +/** + * Returns a Range object that represents the entire pivot table report, but doesn't include page fields. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.TableRange1 = ApiPivotTable.prototype.GetTableRange1 (); + +/** + * Returns a Range object that represents the entire pivot table report, including page fields. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetTableRange2 = function () { return new ApiRange(); }; + +/** + * Returns a Range object that represents the entire pivot table report, including page fields. + * @memberof ApiPivotTable + * @returns {ApiRange | null} + * @since 8.2.0 + */ +ApiPivotTable.prototype.TableRange2 = ApiPivotTable.prototype.GetTableRange2 (); + +/** + * Returns the text string label that is displayed in the grand total column or row heading in the specified pivot table report. + * @memberof ApiPivotTable + * @returns {string} + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetGrandTotalName = function () { return ""; }; + +/** + * Sets the text string label that is displayed in the grand total column or row heading in the specified pivot table report. + * @memberof ApiPivotTable + * @param {string} name - The grand total name. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetGrandTotalName = function (name) {}; + +/** + * Sets the text string label that is displayed in the grand total column or row heading in the specified pivot table report. + * @memberof ApiPivotTable + * @param {string} name - The grand total name. + * @since 8.2.0 + */ +ApiPivotTable.prototype.GrandTotalName = ApiPivotTable.prototype.SetGrandTotalName (); + +/** + * Sets the setting which specifies whether to insert blank rows after each item. + * @memberof ApiPivotTable + * @param {boolean} insert - Specifies whether to insert blank rows after each item. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetLayoutBlankLine = function (insert) {}; + +/** + * Sets the setting which specifies whether to insert blank rows after each item. + * @memberof ApiPivotTable + * @param {boolean} insert - Specifies whether to insert blank rows after each item. + * @since 8.2.0 + */ +ApiPivotTable.prototype.LayoutBlankLine = ApiPivotTable.prototype.SetLayoutBlankLine (); + +/** + * Sets the setting which specifies whether to show subtotals. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to show subtotals. + * @since 8.2.0 + */ +ApiPivotTable.prototype.SetLayoutSubtotals = function (show) {}; + +/** + * Sets the setting which specifies whether to show subtotals. + * @memberof ApiPivotTable + * @param {boolean} show - Specifies whether to show subtotals. + * @since 8.2.0 + */ +ApiPivotTable.prototype.LayoutSubtotals = ApiPivotTable.prototype.SetLayoutSubtotals (); + +/** + * Returns the parent object for the current pivot table. + * @memberof ApiPivotTable + * @returns {ApiWorksheet} - The parent object for the current pivot table. + * @since 8.2.0 + */ +ApiPivotTable.prototype.GetParent = function () { return new ApiWorksheet(); }; + +/** + * Returns the parent object for the current pivot table. + * @memberof ApiPivotTable + * @returns {ApiWorksheet} - The parent object for the current pivot table. + * @since 8.2.0 + */ +ApiPivotTable.prototype.Parent = ApiPivotTable.prototype.GetParent (); + +/** Methods */ + +/** + * Removes the current data field from the category. + * @memberof ApiPivotDataField + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Remove = function () {}; + +/** + * Moves the current data field inside the category. + * @memberof ApiPivotDataField + * @param {PivotMoveFieldType | PivotFieldOrientationType} type - The direction to move the pivot table field, + * or the pivot field orientation type. + * @param {number} [index] - The index of the data field in a new category. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Move = function (type, index) {}; + +/** Attributes */ + +/** + * The type of calculation to perform on the data field items. + * @typedef {"Average" | "CountNumbers" | "Count" | "Max" | "Min" | "Product" | + * "StdDev" | "StdDevP" | "Sum" | "Var" | "VarP"} DataConsolidateFunctionType + */ + +/** + * Sets a function to the current data field. + * @memberof ApiPivotDataField + * @param {DataConsolidateFunctionType} func - The function to perform in the added data field. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.SetFunction = function (func) {}; + +/** + * Returns a function performed in the data field. + * @memberof ApiPivotDataField + * @returns {DataConsolidateFunctionType} func - The function performed in the added data field. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetFunction = function () { return new DataConsolidateFunctionType(); }; + +/** + * Returns a value that represents the data field position within a category. + * @memberof ApiPivotDataField + * @returns {number} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetPosition = function () { return 0; }; + +/** + * Sets a value that represents the data field position within a category. + * @memberof ApiPivotDataField + * @param {number} position - The data field position. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.SetPosition = function (position) {}; + +/** + * Sets a value that represents the data field position within a category. + * @memberof ApiPivotDataField + * @param {number} position - The data field position. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Position = ApiPivotDataField.prototype.SetPosition (); + +/** + * Returns a data field orientation value that represents the data field location in the specified pivot table report. + * @memberof ApiPivotDataField + * @returns {PivotFieldOrientationType} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetOrientation = function () { return new PivotFieldOrientationType(); }; + +/** + * Returns a data field orientation value that represents the data field location in the specified pivot table report. + * @memberof ApiPivotDataField + * @returns {PivotFieldOrientationType} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Orientation = ApiPivotDataField.prototype.GetOrientation (); + +/** + * Returns a value representing the name of the specified data field in the pivot table report. + * @memberof ApiPivotDataField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetValue = function () { return ""; }; + +/** + * Sets a value representing the name of the specified data field in the pivot table report. + * @memberof ApiPivotDataField + * @param {string} name - The name of the specified field in the pivot table report. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.SetValue = function (name) {}; + +/** + * Sets a value representing the name of the specified data field in the pivot table report. + * @memberof ApiPivotDataField + * @param {string} name - The name of the specified field in the pivot table report. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Value = ApiPivotDataField.prototype.SetValue (); + +/** + * Returns a value that represents the label text for the data field. + * @memberof ApiPivotDataField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetCaption = function () { return ""; }; + +/** + * Sets a value that represents the label text for the data field. + * @memberof ApiPivotDataField + * @param {string} caption - The label text for the data field. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.SetCaption = function (caption) {}; + +/** + * Sets a value that represents the label text for the data field. + * @memberof ApiPivotDataField + * @param {string} caption - The label text for the data field. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Caption = ApiPivotDataField.prototype.SetCaption (); + +/** + * Returns a value representing the object name. + * @memberof ApiPivotDataField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetName = function () { return ""; }; + +/** + * Sets a value representing the object name. + * @memberof ApiPivotDataField + * @param {string} name - The object name. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.SetName = function (name) {}; + +/** + * Sets a value representing the object name. + * @memberof ApiPivotDataField + * @param {string} name - The object name. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Name = ApiPivotDataField.prototype.SetName (); + +/** + * Returns a value that represents the format code for the object. + * @memberof ApiPivotDataField + * @returns {string | null} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetNumberFormat = function () { return ""; }; + +/** + * Sets a value that represents the format code for the object. + * @memberof ApiPivotDataField + * @param {string} format - The format code for the object. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.SetNumberFormat = function (format) {}; + +/** + * Sets a value that represents the format code for the object. + * @memberof ApiPivotDataField + * @param {string} format - The format code for the object. + * @since 8.2.0 + */ +ApiPivotDataField.prototype.NumberFormat = ApiPivotDataField.prototype.SetNumberFormat (); + +/** + * Returns an index of the data field. + * @memberof ApiPivotDataField + * @returns {number} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetIndex = function () { return 0; }; + +/** + * Returns an index of the data field. + * @memberof ApiPivotDataField + * @returns {number} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.Index = ApiPivotDataField.prototype.GetIndex (); + +/** + * Returns the pivot field from which the data field was created. + * @memberof ApiPivotDataField + * @returns {ApiPivotField} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.GetPivotField = function () { return new ApiPivotField(); }; + +/** + * Returns the pivot field from which the data field was created. + * @memberof ApiPivotDataField + * @returns {ApiPivotField} + * @since 8.2.0 + */ +ApiPivotDataField.prototype.PivotField = ApiPivotDataField.prototype.GetPivotField (); + +/** Methods */ + +/** + * Deletes all filters currently applied to the pivot field. + * @memberof ApiPivotField + * @since 8.2.0 + */ +ApiPivotField.prototype.ClearAllFilters = function () {}; + +/** + * Deletes all label filters or all date filters from the pivot filters collection. + * @memberof ApiPivotField + * @since 8.2.0 + */ +ApiPivotField.prototype.ClearLabelFilters = function () {}; + +/** + * Deletes all manual filters from the pivot filters collection. + * @memberof ApiPivotField + * @since 8.2.0 + */ +ApiPivotField.prototype.ClearManualFilters = function () {}; + +/** + * Deletes all value filters from the pivot filters collection. + * @memberof ApiPivotField + * @since 8.2.0 + */ +ApiPivotField.prototype.ClearValueFilters = function () {}; + +/** + * Returns an object that represents either a single pivot table item (the ApiPivotItem object) + * or a collection of all the visible and hidden items (an array of the ApiPivotItem objects) in the specified field. + * @memberof ApiPivotField + * @param {number} [index] - The item index. + * @returns {ApiPivotItem[] | ApiPivotItem | null} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetPivotItems = function (index) { return [new ApiPivotItem()]; }; + +/** + * Returns an object that represents either a single pivot table item (the ApiPivotItem object) + * or a collection of all the visible and hidden items (an array of the ApiPivotItem objects) in the specified field. + * @memberof ApiPivotField + * @param {number} [index] - The item index. + * @returns {ApiPivotItem[] | ApiPivotItem | null} + * @since 8.2.0 + */ +ApiPivotField.prototype.PivotItems = ApiPivotField.prototype.GetPivotItems (); + +/** + * Moves the current pivot field inside the category. + * @memberof ApiPivotField + * @param {PivotMoveFieldType | PivotFieldOrientationType} type - The direction to move the pivot table field, + * or the pivot field orientation type. + * @param {number | undefined} index - The field index in a new category. + * @since 8.2.0 + */ +ApiPivotField.prototype.Move = function (type, index) {}; + +/** + * Removes the current pivot field from the pivot table. + * @memberof ApiPivotField + * @since 8.2.0 + */ +ApiPivotField.prototype.Remove = function () {}; + +/** Attributes */ + +/** + * Returns a value that represents the position of the field (first, second, third, and so on) + * among all the fields in its orientation (Rows, Columns, Pages, Data). + * @memberof ApiPivotField + * @returns {number} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetPosition = function () { return 0; }; + +/** + * Sets a value that represents the position of the field (first, second, third, and so on) + * among all the fields in its orientation (Rows, Columns, Pages, Data). + * @memberof ApiPivotField + * @param {number} position - The field position. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetPosition = function (position) {}; + +/** + * Sets a value that represents the position of the field (first, second, third, and so on) + * among all the fields in its orientation (Rows, Columns, Pages, Data). + * @memberof ApiPivotField + * @param {number} position - The field position. + * @since 8.2.0 + */ +ApiPivotField.prototype.Position = ApiPivotField.prototype.SetPosition (); + +/** + * Returns a pivot field orientation value that represents the location + * of the field in the specified pivot table report. + * @memberof ApiPivotField + * @returns {PivotFieldOrientationType} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetOrientation = function () { return new PivotFieldOrientationType(); }; + +/** + * Sets a pivot field orientation value that represents the location + * of the field in the specified pivot table report. + * @memberof ApiPivotField + * @param {PivotFieldOrientationType} type - The pivot field orientation type. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetOrientation = function (type) {}; + +/** + * Sets a pivot field orientation value that represents the location + * of the field in the specified pivot table report. + * @memberof ApiPivotField + * @param {PivotFieldOrientationType} type - The pivot field orientation type. + * @since 8.2.0 + */ +ApiPivotField.prototype.Orientation = ApiPivotField.prototype.SetOrientation (); + +/** + * Returns a value representing the name of the specified field in the pivot table report. + * @memberof ApiPivotField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetValue = function () { return ""; }; + +/** + * Sets a value representing the name of the specified field in the pivot table report. + * @memberof ApiPivotField + * @param {string} name - The name of the specified field in the pivot table report. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetValue = function (name) {}; + +/** + * Sets a value representing the name of the specified field in the pivot table report. + * @memberof ApiPivotField + * @param {string} name - The name of the specified field in the pivot table report. + * @since 8.2.0 + */ +ApiPivotField.prototype.Value = ApiPivotField.prototype.SetValue (); + +/** + * Returns a value that represents the label text for the pivot field. + * @memberof ApiPivotField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetCaption = function () { return ""; }; + +/** + * Sets a value that represents the label text for the pivot field. + * @memberof ApiPivotField + * @param {string} caption - The label text for the pivot field. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetCaption = function (caption) {}; + +/** + * Sets a value that represents the label text for the pivot field. + * @memberof ApiPivotField + * @param {string} caption - The label text for the pivot field. + * @since 8.2.0 + */ +ApiPivotField.prototype.Caption = ApiPivotField.prototype.SetCaption (); + +/** + * Returns a value representing the object name. + * @memberof ApiPivotField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetName = function () { return ""; }; + +/** + * Sets a value representing the object name. + * @memberof ApiPivotField + * @param {string} name - The object name. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetName = function (name) {}; + +/** + * Sets a value representing the object name. + * @memberof ApiPivotField + * @param {string} name - The object name. + * @since 8.2.0 + */ +ApiPivotField.prototype.Name = ApiPivotField.prototype.SetName (); + +/** + * Returns a source name for the pivot table field. + * @memberof ApiPivotField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetSourceName = function () { return ""; }; + +/** + * Returns a source name for the pivot table field. + * @memberof ApiPivotField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotField.prototype.SourceName = ApiPivotField.prototype.GetSourceName (); + +/** + * Returns an index for the pivot table field. + * @memberof ApiPivotField + * @returns {number} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetIndex = function () { return 0; }; + +/** + * Returns an index for the pivot table field. + * @memberof ApiPivotField + * @returns {number} + * @since 8.2.0 + */ +ApiPivotField.prototype.Index = ApiPivotField.prototype.GetIndex (); + +/** + * Returns the ApiPivotTable object which represents the pivot table for the current field. + * @memberof ApiPivotField + * @returns {ApiPivotTable} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetTable = function () { return new ApiPivotTable(); }; + +/** + * Returns the ApiPivotTable object which represents the pivot table for the current field. + * @memberof ApiPivotField + * @returns {ApiPivotTable} + * @since 8.2.0 + */ +ApiPivotField.prototype.Table = ApiPivotField.prototype.GetTable (); + +/** + * Returns the parent object for the current field. + * @memberof ApiPivotField + * @returns {ApiPivotTable} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetParent = function () { return new ApiPivotTable(); }; + +/** + * Returns the parent object for the current field. + * @memberof ApiPivotField + * @returns {ApiPivotTable} + * @since 8.2.0 + */ +ApiPivotField.prototype.Parent = ApiPivotField.prototype.GetParent (); + +/** + * Returns the setting which specifies whether a pivot table field is compacted. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetLayoutCompactRow = function () { return true; }; + +/** + * Sets the setting which specifies whether a pivot table field is compacted. + * @memberof ApiPivotField + * @param {boolean} compact - Specifies whether a pivot table field is compacted. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetLayoutCompactRow = function (compact) {}; + +/** + * Sets the setting which specifies whether a pivot table field is compacted. + * @memberof ApiPivotField + * @param {boolean} compact - Specifies whether a pivot table field is compacted. + * @since 8.2.0 + */ +ApiPivotField.prototype.LayoutCompactRow = ApiPivotField.prototype.SetLayoutCompactRow (); + +/** + * The layout type of the pivot table report. + * @typedef {"Tabular" | "Outline"} PivotLayoutType + */ + +/** + * Returns the way the specified pivot table items appear — in table format or in outline format. + * @memberof ApiPivotField + * @returns {PivotLayoutType} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetLayoutForm = function () { return new PivotLayoutType(); }; + +/** + * Sets the way the specified pivot table items appear — in table format or in outline format. + * @memberof ApiPivotField + * @param {PivotLayoutType} type - The layout type of the pivot table report. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetLayoutForm = function (type) {}; + +/** + * Sets the way the specified pivot table items appear — in table format or in outline format. + * @memberof ApiPivotField + * @param {PivotLayoutType} type - The layout type of the pivot table report. + * @since 8.2.0 + */ +ApiPivotField.prototype.LayoutForm = ApiPivotField.prototype.SetLayoutForm (); + +/** + * Returns the setting which specifies whether to insert a page break after each field. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetLayoutPageBreak = function () { return true; }; + +/** + * Sets the setting which specifies whether to insert a page break after each field. + * @memberof ApiPivotField + * @param {boolean} insert - Specifies whether to insert a page break after each field. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetLayoutPageBreak = function (insert) {}; + +/** + * Sets the setting which specifies whether to insert a page break after each field. + * @memberof ApiPivotField + * @param {boolean} insert - Specifies whether to insert a page break after each field. + * @since 8.2.0 + */ +ApiPivotField.prototype.LayoutPageBreak = ApiPivotField.prototype.SetLayoutPageBreak (); + +/** + * Returns the setting which specifies whether the pivot table field is currently visible in the pivot table. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetShowingInAxis = function () { return true; }; + +/** + * Returns the setting which specifies whether the pivot table field is currently visible in the pivot table. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.ShowingInAxis = ApiPivotField.prototype.GetShowingInAxis (); + +/** + * Returns the setting which specifies whether to repeat items labels at each row. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetRepeatLabels = function () { return true; }; + +/** + * Sets the setting which specifies whether to repeat items labels at each row. + * @memberof ApiPivotField + * @param {boolean} repeat - Specifies whether to repeat items labels at each row. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetRepeatLabels = function (repeat) {}; + +/** + * Sets the setting which specifies whether to repeat items labels at each row. + * @memberof ApiPivotField + * @param {boolean} repeat - Specifies whether to repeat items labels at each row. + * @since 8.2.0 + */ +ApiPivotField.prototype.RepeatLabels = ApiPivotField.prototype.SetRepeatLabels (); + +/** + * Returns the setting which specifies whether to insert blank rows after each item. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetLayoutBlankLine = function () { return true; }; + +/** + * Sets the setting which specifies whether to insert blank rows after each item. + * @memberof ApiPivotField + * @param {boolean} insert - Specifies whether to insert blank rows after each item. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetLayoutBlankLine = function (insert) {}; + +/** + * Sets the setting which specifies whether to insert blank rows after each item. + * @memberof ApiPivotField + * @param {boolean} insert - Specifies whether to insert blank rows after each item. + * @since 8.2.0 + */ +ApiPivotField.prototype.LayoutBlankLine = ApiPivotField.prototype.SetLayoutBlankLine (); + +/** + * Returns the setting which specifies whether to show items with no data. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetShowAllItems = function () { return true; }; + +/** + * Sets the setting which specifies whether to show items with no data. + * @memberof ApiPivotField + * @param {boolean} show - Specifies whether to show items with no data. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetShowAllItems = function (show) {}; + +/** + * Sets the setting which specifies whether to show items with no data. + * @memberof ApiPivotField + * @param {boolean} show - Specifies whether to show items with no data. + * @since 8.2.0 + */ +ApiPivotField.prototype.ShowAllItems = ApiPivotField.prototype.SetShowAllItems (); + +/** + * Returns the setting which specifies whether to show subtotals. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetLayoutSubtotals = function () { return true; }; + +/** + * Sets the setting which specifies whether to show subtotals. + * @memberof ApiPivotField + * @param {boolean} show - Specifies whether to show subtotals. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetLayoutSubtotals = function (show) {}; + +/** + * Sets the setting which specifies whether to show subtotals. + * @memberof ApiPivotField + * @param {boolean} show - Specifies whether to show subtotals. + * @since 8.2.0 + */ +ApiPivotField.prototype.LayoutSubtotals = ApiPivotField.prototype.SetLayoutSubtotals (); + +/** + * The layout subtotal location. + * @typedef { "Top" | "Bottom" } LayoutSubtotalLocationType + */ + +/** + * Returns the layout subtotal location. + * @memberof ApiPivotField + * @returns {LayoutSubtotalLocationType} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetLayoutSubtotalLocation = function () { return new LayoutSubtotalLocationType(); }; + +/** + * Sets the layout subtotal location. + * @memberof ApiPivotField + * @param {LayoutSubtotalLocationType} type - The layout subtotal location. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetLayoutSubtotalLocation = function (type) {}; + +/** + * Sets the layout subtotal location. + * @memberof ApiPivotField + * @param {LayoutSubtotalLocationType} type - The layout subtotal location. + * @since 8.2.0 + */ +ApiPivotField.prototype.LayoutSubtotalLocation = ApiPivotField.prototype.SetLayoutSubtotalLocation (); + +/** + * Returns the text label displayed in the subtotal column or row heading in the specified pivot table report. + * @memberof ApiPivotField + * @returns {string} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetSubtotalName = function () { return ""; }; + +/** + * Sets the text label displayed in the subtotal column or row heading in the specified pivot table report. + * @memberof ApiPivotField + * @param {string} caption - The text label displayed in the subtotal column or row heading. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetSubtotalName = function (caption) {}; + +/** + * Sets the text label displayed in the subtotal column or row heading in the specified pivot table report. + * @memberof ApiPivotField + * @param {string} caption - The text label displayed in the subtotal column or row heading. + * @since 8.2.0 + */ +ApiPivotField.prototype.SubtotalName = ApiPivotField.prototype.SetSubtotalName (); + +/** + * Subtotal pivot field types (functions for subtotals). + * @typedef {Object} PivotFieldSubtotals + * @property {boolean} Sum - Specififes whether the SUM function will be used. + * @property {boolean} Count - Specififes whether the COUNTA function will be used. + * @property {boolean} Average - Specififes whether the AVERAGE function will be used. + * @property {boolean} Max - Specififes whether the MAX function will be used. + * @property {boolean} Min - Specififes whether the MIN function will be used. + * @property {boolean} Product - Specififes whether the PRODUCT function will be used. + * @property {boolean} CountNumbers - Specififes whether the COUNT function will be used. + * @property {boolean} StdDev - Specififes whether the STDEV function will be used. + * @property {boolean} StdDevP - Specififes whether the STDEV.P function will be used. + * @property {boolean} Var - Specififes whether the VAR function will be used. + * @property {boolean} VarP - Specififes whether the VAR.P function will be used. + */ + +/** + * Returns an object that represents all subtotals. + * @memberof ApiPivotField + * @returns {PivotFieldSubtotals} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetSubtotals = function () { return new PivotFieldSubtotals(); }; + +/** + * Sets an object that represents all subtotals. + * @memberof ApiPivotField + * @param {PivotFieldSubtotals} subtotals - An object that represents all subtotals or some of them. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetSubtotals = function (subtotals) {}; + +/** + * Sets an object that represents all subtotals. + * @memberof ApiPivotField + * @param {PivotFieldSubtotals} subtotals - An object that represents all subtotals or some of them. + * @since 8.2.0 + */ +ApiPivotField.prototype.Subtotals = ApiPivotField.prototype.SetSubtotals (); + +/** + * Returns the setting which specifies whether the specified field can be dragged to the column position. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetDragToColumn = function () { return true; }; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the column position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the column position. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetDragToColumn = function (flag) {}; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the column position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the column position. + * @since 8.2.0 + */ +ApiPivotField.prototype.DragToColumn = ApiPivotField.prototype.SetDragToColumn (); + +/** + * Returns the setting which specifies whether the specified field can be dragged to the row position. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetDragToRow = function () { return true; }; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the row position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the row position. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetDragToRow = function (flag) {}; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the row position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the row position. + * @since 8.2.0 + */ +ApiPivotField.prototype.DragToRow = ApiPivotField.prototype.SetDragToRow (); + +/** + * Returns the setting which specifies whether the specified field can be dragged to the data position. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetDragToData = function () { return true; }; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the data position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the data position. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetDragToData = function (flag) {}; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the data position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the data position. + * @since 8.2.0 + */ +ApiPivotField.prototype.DragToData = ApiPivotField.prototype.SetDragToData (); + +/** + * Returns the setting which specifies whether the specified field can be dragged to the page position. + * @memberof ApiPivotField + * @returns {boolean} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetDragToPage = function () { return true; }; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the page position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the page position. + * @since 8.2.0 + */ +ApiPivotField.prototype.SetDragToPage = function (flag) {}; + +/** + * Sets the setting which specifies whether the specified field can be dragged to the page position. + * @memberof ApiPivotField + * @param {boolean} flag - Specifies whether the specified field can be dragged to the page position. + * @since 8.2.0 + */ +ApiPivotField.prototype.DragToPage = ApiPivotField.prototype.SetDragToPage (); + +/** + * Returns the current page which is displayed for the page field (valid only for page fields). + * @memberof ApiPivotField + * @returns {string | number} + * @since 8.2.0 + */ +ApiPivotField.prototype.GetCurrentPage = function () { return ""; }; + +/** + * Returns the current page which is displayed for the page field (valid only for page fields). + * @memberof ApiPivotField + * @returns {string | number} + * @since 8.2.0 + */ +ApiPivotField.prototype.CurrentPage = ApiPivotField.prototype.GetCurrentPage (); + +/** + * Returns a name of the pivot item. + * @memberof ApiPivotItem + * @returns {string} + * @since 8.2.0 + */ +ApiPivotItem.prototype.GetName = function () { return ""; }; + +/** + * Returns a name of the pivot item. + * @memberof ApiPivotItem + * @returns {string} + * @since 8.2.0 + */ +ApiPivotItem.prototype.Name = ApiPivotItem.prototype.GetName (); + +/** + * Returns a caption of the pivot item. + * @memberof ApiPivotItem + * @returns {string} + * @since 8.2.0 + */ +ApiPivotItem.prototype.GetCaption = function () { return ""; }; + +/** + * Returns a caption of the pivot item. + * @memberof ApiPivotItem + * @returns {string} + * @since 8.2.0 + */ +ApiPivotItem.prototype.Caption = ApiPivotItem.prototype.GetCaption (); + +/** + * Returns a name of the specified item in the pivot table field. + * @memberof ApiPivotItem + * @returns {string} + * @since 8.2.0 + */ +ApiPivotItem.prototype.GetValue = function () { return ""; }; + +/** + * Returns a name of the specified item in the pivot table field. + * @memberof ApiPivotItem + * @returns {string} + * @since 8.2.0 + */ +ApiPivotItem.prototype.Value = ApiPivotItem.prototype.GetValue (); + +/** + * Returns a parent of the pivot item. + * @memberof ApiPivotItem + * @returns {ApiPivotField} + * @since 8.2.0 + */ +ApiPivotItem.prototype.GetParent = function () { return new ApiPivotField(); }; + +/** + * Returns a parent of the pivot item. + * @memberof ApiPivotItem + * @returns {ApiPivotField} + * @since 8.2.0 + */ +ApiPivotItem.prototype.Parent = ApiPivotItem.prototype.GetParent (); + diff --git a/vendor/monaco/libs/slide/api.js b/vendor/monaco/libs/slide/api.js index 44791331d9..d28f32fd67 100644 --- a/vendor/monaco/libs/slide/api.js +++ b/vendor/monaco/libs/slide/api.js @@ -8,6 +8,26 @@ var ApiInterface = function() {}; var Api = new ApiInterface(); +/** + * This element specifies the information which shall be used to establish a mapping to an XML element stored within a Custom XML. + * @typedef {Object} XmlMapping + * @property {string} prefixMapping The set of prefix mappings which shall be used to interpret the XPath expression specified in xpath. + * @property {string} xpath The XPath expression. + * @property {string} storeItemID The custom XML data identifier. + * @example + * { + * "prefixMapping": "xmlns:ns0='http://example.com/example'", + * "xpath": "//ns0:book", + * "storeItemID": "testXmlPart" + * } + */ + +/** + * Class representing a bookmark in the document. + * @constructor + */ +function ApiBookmark(startMark, endMark){} + /** * Class representing a container for paragraphs and tables. * @param Document @@ -15,14 +35,6 @@ var Api = new ApiInterface(); */ function ApiDocumentContent(Document){} -/** - * Class representing the Markdown conversion processing. - * Each Range object is determined by the position of the start and end characters. - * @constructor - */ -function CMarkdownConverter(oConfig){} -CMarkdownConverter.prototype.constructor = CMarkdownConverter; - /** * Class representing a continuous region in a document. * Each Range object is determined by the position of the start and end characters. @@ -34,22 +46,6 @@ CMarkdownConverter.prototype.constructor = CMarkdownConverter; function ApiRange(oElement, Start, End){} ApiRange.prototype.constructor = ApiRange; -/** - * Returns a paragraph from all the paragraphs that are in the range. - * @param {Number} nPos - The paragraph position in the range. - * @returns {ApiParagraph | null} - returns null if position is invalid. - */ -ApiRange.prototype.GetParagraph = function(nPos){ return new ApiParagraph(); }; - -/** - * Class representing a document. - * @constructor - * @extends {ApiDocumentContent} - */ -function ApiDocument(Document){} -ApiDocument.prototype = Object.create(ApiDocumentContent.prototype); -ApiDocument.prototype.constructor = ApiDocument; - /** * Class representing the paragraph properties. * @constructor @@ -111,6 +107,71 @@ function ApiCommentReply(oParentComm, oCommentReply){} function ApiHyperlink(ParaHyperlink){} ApiHyperlink.prototype.constructor = ApiHyperlink; +/** + * Returns a type of the ApiHyperlink class. + * @memberof ApiHyperlink + * @returns {"hyperlink"} + */ +ApiHyperlink.prototype.GetClassType = function(){ return ""; }; + +/** + * Sets the hyperlink address. + * @param {string} sLink - The hyperlink address. + * @returns {boolean} + */ +ApiHyperlink.prototype.SetLink = function(sLink){ return true; }; + +/** + * Sets the hyperlink display text. + * @param {string} sDisplay - The text to display the hyperlink. + * @returns {boolean} + */ +ApiHyperlink.prototype.SetDisplayedText = function(sDisplay){ return true; }; + +/** + * Sets the screen tip text of the hyperlink. + * @param {string} sScreenTipText - The screen tip text of the hyperlink. + * @returns {boolean} + */ +ApiHyperlink.prototype.SetScreenTipText = function(sScreenTipText){ return true; }; + +/** + * Returns the hyperlink address. + * @returns {string} + */ +ApiHyperlink.prototype.GetLinkedText = function(){ return ""; }; + +/** + * Returns the hyperlink display text. + * @returns {string} + */ +ApiHyperlink.prototype.GetDisplayedText = function(){ return ""; }; + +/** + * Returns the screen tip text of the hyperlink. + * @returns {string} + */ +ApiHyperlink.prototype.GetScreenTipText = function(){ return ""; }; + +/** + * Returns the hyperlink element using the position specified. + * @param {number} nPos - The position where the element which content we want to get must be located. + * @returns {ParagraphContent} + */ +ApiHyperlink.prototype.GetElement = function(nPos){ return new ParagraphContent(); }; + +/** + * Returns a number of elements in the current hyperlink. + * @returns {number} + */ +ApiHyperlink.prototype.GetElementsCount = function(){ return 0; }; + +/** + * Sets the default hyperlink style. + * @returns {boolean} + */ +ApiHyperlink.prototype.SetDefaultStyle = function(){ return true; }; + /** * Class representing a style. * @constructor @@ -160,6 +221,22 @@ function ApiTableStylePr(Type, Parent, TableStylePr){} */ function ApiUnsupported(){} +/** + * Class representing a chart. + * @constructor + * + */ +function ApiChart(Chart){} +ApiChart.prototype = Object.create(ApiDrawing.prototype); +ApiChart.prototype.constructor = ApiChart; + +/** + * Class representing a chart series. + * @constructor + * + */ +function ApiChartSeries(oChartSpace, nIdx){} + /** * Class representing a base class for color types. * @constructor @@ -185,7 +262,7 @@ ApiSchemeColor.prototype.constructor = ApiSchemeColor; /** * Class representing a Preset Color. * @constructor - * */ + */ function ApiPresetColor(sPresetColor){} ApiPresetColor.prototype = Object.create(ApiUniColor.prototype); ApiPresetColor.prototype.constructor = ApiPresetColor; @@ -193,7 +270,7 @@ ApiPresetColor.prototype.constructor = ApiPresetColor; /** * Class representing a base class for fill. * @constructor - * */ + */ function ApiFill(UniFill){} /** @@ -205,7 +282,7 @@ function ApiStroke(oLn){} /** * Class representing gradient stop. * @constructor - * */ + */ function ApiGradientStop(oApiUniColor, pos){} /** @@ -215,13 +292,13 @@ function ApiGradientStop(oApiUniColor, pos){} function ApiInlineLvlSdt(Sdt){} /** - * Class representing a list of values of the combo box / dropdown list content control. + * Class representing a list of values of the combo box / drop-down list content control. * @constructor */ function ApiContentControlList(Parent){} /** - * Class representing an entry of the combo box / dropdown list content control. + * Class representing an entry of the combo box / drop-down list content control. * @constructor */ function ApiContentControlListEntry(Sdt, Parent, Text, Value){} @@ -238,6 +315,18 @@ function ApiBlockLvlSdt(Sdt){} */ function ApiWatermarkSettings(oSettings){} +/** + * Class representing document properties (similar to BuiltInDocumentProperties in VBA). + * @constructor + */ +function ApiCore(oCore) {} + +/** + * Class representing custom properties of the document. + * @constructor + */ +function ApiCustomProperties(oCustomProperties) {} + /** * Twentieths of a point (equivalent to 1/1440th of an inch). * @typedef {number} twips @@ -271,12 +360,12 @@ function ApiWatermarkSettings(oSettings){} /** * 60000th of a degree (5400000 = 90 degrees). * @typedef {number} PositiveFixedAngle - * */ + */ /** * A border type which will be added to the document element. - * * "none" - no border will be added to the created element or the selected element side. - * * "single" - a single border will be added to the created element or the selected element side. + * "none" - no border will be added to the created element or the selected element side. + * "single" - a single border will be added to the created element or the selected element side. * @typedef {("none" | "single")} BorderType */ @@ -302,36 +391,36 @@ function ApiWatermarkSettings(oSettings){} /** * Header and footer types which can be applied to the document sections. - * * "default" - a header or footer which can be applied to any default page. - * * "title" - a header or footer which is applied to the title page. - * * "even" - a header or footer which can be applied to even pages to distinguish them from the odd ones (which will be considered default). + * "default" - a header or footer which can be applied to any default page. + * "title" - a header or footer which is applied to the title page. + * "even" - a header or footer which can be applied to even pages to distinguish them from the odd ones (which will be considered default). * @typedef {("default" | "title" | "even")} HdrFtrType */ /** * The possible values for the units of the width property are defined by a specific table or table cell width property. - * * "auto" - sets the table or table cell width to auto width. - * * "twips" - sets the table or table cell width to be measured in twentieths of a point. - * * "nul" - sets the table or table cell width to be of a zero value. - * * "percent" - sets the table or table cell width to be measured in percent to the parent container. + * "auto" - sets the table or table cell width to auto width. + * "twips" - sets the table or table cell width to be measured in twentieths of a point. + * "nul" - sets the table or table cell width to be of a zero value. + * "percent" - sets the table or table cell width to be measured in percent to the parent container. * @typedef {("auto" | "twips" | "nul" | "percent")} TableWidth */ /** * This simple type specifies possible values for the table sections to which the current conditional formatting properties will be applied when this selected table style is used. - * * "topLeftCell" - specifies that the table formatting is applied to the top left cell. - * * "topRightCell" - specifies that the table formatting is applied to the top right cell. - * * "bottomLeftCell" - specifies that the table formatting is applied to the bottom left cell. - * * "bottomRightCell" - specifies that the table formatting is applied to the bottom right cell. - * * "firstRow" - specifies that the table formatting is applied to the first row. - * * "lastRow" - specifies that the table formatting is applied to the last row. - * * "firstColumn" - specifies that the table formatting is applied to the first column. Any subsequent row which is in *table header* ({@link ApiTableRowPr#SetTableHeader}) will also use this conditional format. - * * "lastColumn" - specifies that the table formatting is applied to the last column. - * * "bandedColumn" - specifies that the table formatting is applied to odd numbered groupings of rows. - * * "bandedColumnEven" - specifies that the table formatting is applied to even numbered groupings of rows. - * * "bandedRow" - specifies that the table formatting is applied to odd numbered groupings of columns. - * * "bandedRowEven" - specifies that the table formatting is applied to even numbered groupings of columns. - * * "wholeTable" - specifies that the conditional formatting is applied to the whole table. + * "topLeftCell" - specifies that the table formatting is applied to the top left cell. + * "topRightCell" - specifies that the table formatting is applied to the top right cell. + * "bottomLeftCell" - specifies that the table formatting is applied to the bottom left cell. + * "bottomRightCell" - specifies that the table formatting is applied to the bottom right cell. + * "firstRow" - specifies that the table formatting is applied to the first row. + * "lastRow" - specifies that the table formatting is applied to the last row. + * "firstColumn" - specifies that the table formatting is applied to the first column. Any subsequent row which is in *table header* ({@link ApiTableRowPr#SetTableHeader}) will also use this conditional format. + * "lastColumn" - specifies that the table formatting is applied to the last column. + * "bandedColumn" - specifies that the table formatting is applied to odd numbered groupings of rows. + * "bandedColumnEven" - specifies that the table formatting is applied to even numbered groupings of rows. + * "bandedRow" - specifies that the table formatting is applied to odd numbered groupings of columns. + * "bandedRowEven" - specifies that the table formatting is applied to even numbered groupings of columns. + * "wholeTable" - specifies that the conditional formatting is applied to the whole table. * @typedef {("topLeftCell" | "topRightCell" | "bottomLeftCell" | "bottomRightCell" | "firstRow" | "lastRow" | * "firstColumn" | "lastColumn" | "bandedColumn" | "bandedColumnEven" | "bandedRow" | "bandedRowEven" | * "wholeTable")} TableStyleOverrideType @@ -378,19 +467,25 @@ function ApiWatermarkSettings(oSettings){} * "barStackedPercent3DPerspective" | "horizontalBar" | "horizontalBarStacked" | "horizontalBarStackedPercent" * | "horizontalBar3D" | "horizontalBarStacked3D" | "horizontalBarStackedPercent3D" | "lineNormal" | * "lineStacked" | "lineStackedPercent" | "line3D" | "pie" | "pie3D" | "doughnut" | "scatter" | "stock" | - * "area" | "areaStacked" | "areaStackedPercent")} ChartType + * "area" | "areaStacked" | "areaStackedPercent" | "comboBarLine" | "comboBarLineSecondary" | "comboCustom" | "unknown")} ChartType + */ + +/** + * This type specifies the type of drawing lock. + * @typedef {("noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" + * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox")} DrawingLockType */ /** * The available text vertical alignment (used to align text in a shape with a placement for text inside it). * @typedef {("top" | "center" | "bottom")} VerticalTextAlign - * */ + */ /** * The available color scheme identifiers. * @typedef {("accent1" | "accent2" | "accent3" | "accent4" | "accent5" | "accent6" | "bg1" | "bg2" | "dk1" | "dk2" * | "lt1" | "lt2" | "tx1" | "tx2")} SchemeColorId - * */ + */ /** * The available preset color names. @@ -405,23 +500,23 @@ function ApiWatermarkSettings(oSettings){} * "dkSlateGray" | "dkSlateGrey" | "dkTurquoise" | "dkViolet" | "dodgerBlue" | "firebrick" | "floralWhite" | * "forestGreen" | "fuchsia" | "gainsboro" | "ghostWhite" | "gold" | "goldenrod" | "gray" | "green" | * "greenYellow" | "grey" | "honeydew" | "hotPink" | "indianRed" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderBlush" | "lawnGreen" | "lemonChiffon" | "lightBlue" | "lightCoral" | "lightCyan" | "lightGoldenrodYellow" | "lightGray" | "lightGreen" | "lightGrey" | "lightPink" | "lightSalmon" | "lightSeaGreen" | "lightSkyBlue" | "lightSlateGray" | "lightSlateGrey" | "lightSteelBlue" | "lightYellow" | "lime" | "limeGreen" | "linen" | "ltBlue" | "ltCoral" | "ltCyan" | "ltGoldenrodYellow" | "ltGray" | "ltGreen" | "ltGrey" | "ltPink" | "ltSalmon" | "ltSeaGreen" | "ltSkyBlue" | "ltSlateGray" | "ltSlateGrey" | "ltSteelBlue" | "ltYellow" | "magenta" | "maroon" | "medAquamarine" | "medBlue" | "mediumAquamarine" | "mediumBlue" | "mediumOrchid" | "mediumPurple" | "mediumSeaGreen" | "mediumSlateBlue" | "mediumSpringGreen" | "mediumTurquoise" | "mediumVioletRed" | "medOrchid" | "medPurple" | "medSeaGreen" | "medSlateBlue" | "medSpringGreen" | "medTurquoise" | "medVioletRed" | "midnightBlue" | "mintCream" | "mistyRose" | "moccasin" | "navajoWhite" | "navy" | "oldLace" | "olive" | "oliveDrab" | "orange" | "orangeRed" | "orchid" | "paleGoldenrod" | "paleGreen" | "paleTurquoise" | "paleVioletRed" | "papayaWhip" | "peachPuff" | "peru" | "pink" | "plum" | "powderBlue" | "purple" | "red" | "rosyBrown" | "royalBlue" | "saddleBrown" | "salmon" | "sandyBrown" | "seaGreen" | "seaShell" | "sienna" | "silver" | "skyBlue" | "slateBlue" | "slateGray" | "slateGrey" | "snow" | "springGreen" | "steelBlue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whiteSmoke" | "yellow" | "yellowGreen")} PresetColor - * */ + */ /** * Possible values for the position of chart tick labels (either horizontal or vertical). - * * "none" - not display the selected tick labels. - * * "nextTo" - sets the position of the selected tick labels next to the main label. - * * "low" - sets the position of the selected tick labels in the part of the chart with lower values. - * * "high" - sets the position of the selected tick labels in the part of the chart with higher values. + * "none" - not display the selected tick labels. + * "nextTo" - sets the position of the selected tick labels next to the main label. + * "low" - sets the position of the selected tick labels in the part of the chart with lower values. + * "high" - sets the position of the selected tick labels in the part of the chart with higher values. * @typedef {("none" | "nextTo" | "low" | "high")} TickLabelPosition - * **/ + */ /** * The type of a fill which uses an image as a background. - * * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. - * * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. + * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. + * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. * @typedef {"tile" | "stretch"} BlipFillType - * */ + */ /** * The available preset patterns which can be used for the fill. @@ -432,7 +527,7 @@ function ApiWatermarkSettings(oSettings){} * "pct75" | "pct80" | "pct90" | "plaid" | "shingle" | "smCheck" | "smConfetti" | "smGrid" | "solidDmnd" | * "sphere" | "trellis" | "upDiag" | "vert" | "wave" | "wdDnDiag" | "wdUpDiag" | "weave" | "zigZag"} * PatternType - * */ + */ /** * @@ -448,12 +543,12 @@ function ApiWatermarkSettings(oSettings){} * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform - * */ + */ /** * Form type. * The available form types. - * @typedef {"textForm" | "comboBoxForm" | "dropDownForm" | "checkBoxForm" | "radioButtonForm" | "pictureForm"} FormType + * @typedef {"textForm" | "comboBoxForm" | "dropDownForm" | "checkBoxForm" | "radioButtonForm" | "pictureForm" | "complexForm"} FormType */ /** @@ -479,62 +574,62 @@ function ApiWatermarkSettings(oSettings){} /** * Available values of the "numbered" reference type: - * * "pageNum" - the numbered item page number; - * * "paraNum" - the numbered item paragraph number; - * * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); - * * "fullCtxParaNum" - the full paragraph number, e.g. "4.1.1"; - * * "text" - the paragraph text value, e.g. if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "pageNum" - the numbered item page number; + * "paraNum" - the numbered item paragraph number; + * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); + * "fullCtxParaNum" - the full paragraph number, e.g. "4.1.1"; + * "text" - the paragraph text value, e.g. if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "text" | "aboveBelow"} numberedRefTo */ /** * Available values of the "heading" reference type: - * * "text" - the entire heading text; - * * "pageNum" - the heading page number; - * * "headingNum" - the heading sequence number; - * * "noCtxHeadingNum" - the abbreviated heading number. Make sure the cursor pointer is in the section you are referencing to, e.g. you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; - * * "fullCtxHeadingNum" - the full heading number even if the cursor pointer is in the same section; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "text" - the entire heading text; + * "pageNum" - the heading page number; + * "headingNum" - the heading sequence number; + * "noCtxHeadingNum" - the abbreviated heading number. Make sure the cursor pointer is in the section you are referencing to, e.g. you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; + * "fullCtxHeadingNum" - the full heading number even if the cursor pointer is in the same section; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"text" | "pageNum" | "headingNum" | "noCtxHeadingNum" | "fullCtxHeadingNum" | "aboveBelow"} headingRefTo */ /** * Available values of the "bookmark" reference type: - * * "text" - the entire bookmark text; - * * "pageNum" - the bookmark page number; - * * "paraNum" - the bookmark paragraph number; - * * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); - * * "fullCtxParaNum - the full paragraph number, e.g. "4.1.1"; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "text" - the entire bookmark text; + * "pageNum" - the bookmark page number; + * "paraNum" - the bookmark paragraph number; + * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); + * "fullCtxParaNum - the full paragraph number, e.g. "4.1.1"; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"text" | "pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "aboveBelow"} bookmarkRefTo */ /** * Available values of the "footnote" reference type: - * * "footnoteNum" - the footnote number; - * * "pageNum" - the page number of the footnote; - * * "aboveBelow" - the words "above" or "below" depending on the position of the item; - * * "formFootnoteNum" - the form number formatted as a footnote. The numbering of the actual footnotes is not affected. + * "footnoteNum" - the footnote number; + * "pageNum" - the page number of the footnote; + * "aboveBelow" - the words "above" or "below" depending on the position of the item; + * "formFootnoteNum" - the form number formatted as a footnote. The numbering of the actual footnotes is not affected. * @typedef {"footnoteNum" | "pageNum" | "aboveBelow" | "formFootnoteNum"} footnoteRefTo */ /** * Available values of the "endnote" reference type: - * * "endnoteNum" - the endnote number; - * * "pageNum" - the endnote page number; - * * "aboveBelow" - the words "above" or "below" depending on the item position; - * * "formEndnoteNum" - the form number formatted as an endnote. The numbering of the actual endnotes is not affected. + * "endnoteNum" - the endnote number; + * "pageNum" - the endnote page number; + * "aboveBelow" - the words "above" or "below" depending on the item position; + * "formEndnoteNum" - the form number formatted as an endnote. The numbering of the actual endnotes is not affected. * @typedef {"endnoteNum" | "pageNum" | "aboveBelow" | "formEndnoteNum"} endnoteRefTo */ /** * Available values of the "equation"/"figure"/"table" reference type: - * * "entireCaption"- the entire caption text; - * * "labelNumber" - the label and object number only, e.g. "Table 1.1"; - * * "captionText" - the caption text only; - * * "pageNum" - the page number containing the referenced object; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "entireCaption"- the entire caption text; + * "labelNumber" - the label and object number only, e.g. "Table 1.1"; + * "captionText" - the caption text only; + * "pageNum" - the page number containing the referenced object; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"entireCaption" | "labelNumber" | "captionText" | "pageNum" | "aboveBelow"} captionRefTo */ @@ -547,8 +642,8 @@ function ApiWatermarkSettings(oSettings){} * Standard numeric format. * @typedef {("General" | "0" | "0.00" | "#,##0" | "#,##0.00" | "0%" | "0.00%" | * "0.00E+00" | "# ?/?" | "# ??/??" | "m/d/yyyy" | "d-mmm-yy" | "d-mmm" | "mmm-yy" | "h:mm AM/PM" | - * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_);(#,##0)" | "#,##0_);[Red](#,##0)" | - * "#,##0.00_);(#,##0.00)" | "#,##0.00_);[Red](#,##0.00)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_\);(#,##0)" | "#,##0_\);\[Red\]\(#,##0)" | + * "#,##0.00_\);\(#,##0.00\)" | "#,##0.00_\);\[Red\]\(#,##0.00\)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat */ /** @@ -558,28 +653,28 @@ function ApiWatermarkSettings(oSettings){} /** * Possible values for the caption numbering format. - * * "ALPHABETIC" - upper letter. - * * "alphabetic" - lower letter. - * * "Roman" - upper Roman. - * * "roman" - lower Roman. - * * "Arabic" - arabic. + * "ALPHABETIC" - upper letter. + * "alphabetic" - lower letter. + * "Roman" - upper Roman. + * "roman" - lower Roman. + * "Arabic" - arabic. * @typedef {("ALPHABETIC" | "alphabetic" | "Roman" | "roman" | "Arabic")} CaptionNumberingFormat - * **/ + */ /** * Possible values for the caption separator. - * * "hyphen" - the "-" punctuation mark. - * * "period" - the "." punctuation mark. - * * "colon" - the ":" punctuation mark. - * * "longDash" - the "—" punctuation mark. - * * "dash" - the "-" punctuation mark. + * "hyphen" - the "-" punctuation mark. + * "period" - the "." punctuation mark. + * "colon" - the ":" punctuation mark. + * "longDash" - the "—" punctuation mark. + * "dash" - the "-" punctuation mark. * @typedef {("hyphen" | "period" | "colon" | "longDash" | "dash")} CaptionSep - * **/ + */ /** * Possible values for the caption label. * @typedef {("Table" | "Equation" | "Figure")} CaptionLabel - * **/ + */ /** * Table of contents properties. @@ -621,31 +716,41 @@ function ApiWatermarkSettings(oSettings){} /** * Possible values for the table of contents leader: - * * "dot" - "......." - * * "dash" - "-------" - * * "underline" - "_______" + * "dot" - "......." + * "dash" - "-------" + * "underline" - "_______" * @typedef {("dot" | "dash" | "underline" | "none")} TocLeader - * **/ + */ /** * Possible values for the table of contents style. * @typedef {("simple" | "online" | "standard" | "modern" | "classic")} TocStyle - * **/ + */ /** * Possible values for the table of figures style. * @typedef {("simple" | "online" | "classic" | "distinctive" | "centered" | "formal")} TofStyle - * **/ + */ + +/** + * Any valid drawing element. + * @typedef {(ApiShape | ApiImage | ApiGroup | ApiOleObject | ApiChart )} Drawing + */ + +/** + * Available drawing element for grouping. + * @typedef {(ApiShape | ApiGroup | ApiImage | ApiChart)} DrawingForGroup + */ /** * The 1000th of a percent (100000 = 100%). * @typedef {number} PositivePercentage - * */ + */ /** * The type of tick mark appearance. * @typedef {("cross" | "in" | "none" | "out")} TickMark - * */ + */ /** * The watermark type. @@ -654,13 +759,18 @@ function ApiWatermarkSettings(oSettings){} /** * The watermark direction. - * @typedef {("horizontal" | "clockwise45" | "counterclockwise45")} WatermarkDirection + * @typedef {("horizontal" | "clockwise45" | "counterclockwise45" | "clockwise90" | "counterclockwise90")} WatermarkDirection + */ + +/** + * The Base64 image string. + * @typedef {string} Base64Img + * @example "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA..." */ /** * Creates a new smaller text block to be inserted to the current paragraph or table. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiInterface.prototype.CreateRun = function(){ return new ApiRun(); }; @@ -668,7 +778,6 @@ ApiInterface.prototype.CreateRun = function(){ return new ApiRun(); }; /** * Creates an RGB color setting the appropriate values for the red, green and blue color components. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -679,121 +788,137 @@ ApiInterface.prototype.CreateRGBColor = function(r, g, b){ return new ApiRGBColo /** * Creates a complex color scheme selecting from one of the available schemes. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {SchemeColorId} sSchemeColorId - The color scheme identifier. + * @param {SchemeColorId} schemeColorId - The color scheme identifier. * @returns {ApiSchemeColor} */ -ApiInterface.prototype.CreateSchemeColor = function(sSchemeColorId){ return new ApiSchemeColor(); }; +ApiInterface.prototype.CreateSchemeColor = function(schemeColorId){ return new ApiSchemeColor(); }; /** * Creates a color selecting it from one of the available color presets. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {PresetColor} sPresetColor - A preset selected from the list of the available color preset names. + * @param {PresetColor} presetColor - A preset selected from the list of the available color preset names. * @returns {ApiPresetColor}; - * */ -ApiInterface.prototype.CreatePresetColor = function(sPresetColor){ return new ApiPresetColor(); }; + */ +ApiInterface.prototype.CreatePresetColor = function(presetColor){ return new ApiPresetColor(); }; /** * Creates a solid fill to apply to the object using a selected solid color as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiUniColor} oUniColor - The color used for the element fill. + * @param {ApiUniColor} uniColor - The color used for the element fill. * @returns {ApiFill} - * */ -ApiInterface.prototype.CreateSolidFill = function(oUniColor){ return new ApiFill(); }; + */ +ApiInterface.prototype.CreateSolidFill = function(uniColor){ return new ApiFill(); }; /** * Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} aGradientStop - The array of gradient color stops measured in 1000th of percent. - * @param {PositiveFixedAngle} Angle - The angle measured in 60000th of a degree that will define the gradient direction. + * @param {number[]} gradientStops - The array of gradient color stops measured in 1000th of percent. + * @param {PositiveFixedAngle} angle - The angle measured in 60000th of a degree that will define the gradient direction. * @returns {ApiFill} */ -ApiInterface.prototype.CreateLinearGradientFill = function(aGradientStop, Angle){ return new ApiFill(); }; +ApiInterface.prototype.CreateLinearGradientFill = function(gradientStops, angle){ return new ApiFill(); }; /** * Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} aGradientStop - The array of gradient color stops measured in 1000th of percent. + * @param {number[]} gradientStops - The array of gradient color stops measured in 1000th of percent. * @returns {ApiFill} */ -ApiInterface.prototype.CreateRadialGradientFill = function(aGradientStop){ return new ApiFill(); }; +ApiInterface.prototype.CreateRadialGradientFill = function(gradientStops){ return new ApiFill(); }; /** * Creates a pattern fill to apply to the object using the selected pattern as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {PatternType} sPatternType - The pattern type used for the fill selected from one of the available pattern types. - * @param {ApiUniColor} BgColor - The background color used for the pattern creation. - * @param {ApiUniColor} FgColor - The foreground color used for the pattern creation. + * @param {PatternType} patternType - The pattern type used for the fill selected from one of the available pattern types. + * @param {ApiUniColor} bgColor - The background color used for the pattern creation. + * @param {ApiUniColor} fgColor - The foreground color used for the pattern creation. * @returns {ApiFill} */ -ApiInterface.prototype.CreatePatternFill = function(sPatternType, BgColor, FgColor){ return new ApiFill(); }; +ApiInterface.prototype.CreatePatternFill = function(patternType, bgColor, fgColor){ return new ApiFill(); }; /** * Creates a blip fill to apply to the object using the selected image as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {string} sImageUrl - The path to the image used for the blip fill (currently only internet URL or Base64 encoded images are supported). - * @param {BlipFillType} sBlipFillType - The type of the fill used for the blip fill (tile or stretch). + * @param {string} imageUrl - The path to the image used for the blip fill (currently only internet URL or Base64 encoded images are supported). + * @param {BlipFillType} blipFillType - The type of the fill used for the blip fill (tile or stretch). * @returns {ApiFill} - * */ -ApiInterface.prototype.CreateBlipFill = function(sImageUrl, sBlipFillType){ return new ApiFill(); }; + */ +ApiInterface.prototype.CreateBlipFill = function(imageUrl, blipFillType){ return new ApiFill(); }; /** * Creates no fill and removes the fill from the element. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiFill} - * */ + */ ApiInterface.prototype.CreateNoFill = function(){ return new ApiFill(); }; /** * Creates a stroke adding shadows to the element. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {EMU} nWidth - The width of the shadow measured in English measure units. - * @param {ApiFill} oFill - The fill type used to create the shadow. + * @param {EMU} width - The width of the shadow measured in English measure units. + * @param {ApiFill} fill - The fill type used to create the shadow. * @returns {ApiStroke} - * */ -ApiInterface.prototype.CreateStroke = function(nWidth, oFill){ return new ApiStroke(); }; + */ +ApiInterface.prototype.CreateStroke = function(width, fill){ return new ApiStroke(); }; /** * Creates a gradient stop used for different types of gradients. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiUniColor} oUniColor - The color used for the gradient stop. - * @param {PositivePercentage} nPos - The position of the gradient stop measured in 1000th of percent. + * @param {ApiUniColor} uniColor - The color used for the gradient stop. + * @param {PositivePercentage} pos - The position of the gradient stop measured in 1000th of percent. * @returns {ApiGradientStop} - * */ -ApiInterface.prototype.CreateGradientStop = function(oUniColor, nPos){ return new ApiGradientStop(); }; + */ +ApiInterface.prototype.CreateGradientStop = function(uniColor, pos){ return new ApiGradientStop(); }; /** * Creates a bullet for a paragraph with the character or symbol specified with the sSymbol parameter. * @memberof ApiInterface - * @typeofeditors ["CSE", "CPE"] * @param {string} sSymbol - The character or symbol which will be used to create the bullet for the paragraph. * @returns {ApiBullet} - * */ + */ ApiInterface.prototype.CreateBullet = function(sSymbol){ return new ApiBullet(); }; /** - * Creates a bullet for a paragraph with the numbering character or symbol specified with the sType parameter. + * Creates a bullet for a paragraph with the numbering character or symbol specified with the numType parameter. * @memberof ApiInterface - * @typeofeditors ["CSE", "CPE"] - * @param {BulletType} sType - The numbering type the paragraphs will be numbered with. - * @param {number} nStartAt - The number the first numbered paragraph will start with. + * @param {BulletType} numType - The numbering type the paragraphs will be numbered with. + * @param {number} startAt - The number the first numbered paragraph will start with. * @returns {ApiBullet} - * */ -ApiInterface.prototype.CreateNumbering = function(sType, nStartAt){ return new ApiBullet(); }; + */ +ApiInterface.prototype.CreateNumbering = function(numType, startAt){ return new ApiBullet(); }; + +/** + * The checkbox content control properties + * @typedef {Object} ContentControlCheckBoxPr + * @property {boolean} [checked] Indicates whether the checkbox is checked by default. + * @property {string} [checkedSymbol] A custom symbol to display when the checkbox is checked (e.g., "в�’"). + * @property {string} [uncheckedSymbol] A custom symbol to display when the checkbox is unchecked (e.g., "в�ђ"). + */ + +/** + * The object representing the items in the combo box or drop-down list. + * @typedef {Object} ContentControlListItem + * @property {string} display - The text to be displayed in the combo box or drop-down list. + * @property {string} value - The value associated with the item. + */ + +/** + * The date picker content control properties. + * @typedef {Object} ContentControlDatePr + * @property {string} format - The date format. Example: "mm.dd.yyyy". + * @property {string} lang - The date language. Possible value for this parameter is a language identifier as defined by + * RFC 4646/BCP 47. Example: "en-CA". + */ + +/** + * Returns a type of the ApiUnsupported class. + * @returns {"unsupported"} + */ +ApiUnsupported.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the ApiDocumentContent class. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"documentContent"} */ ApiDocumentContent.prototype.GetClassType = function(){ return ""; }; @@ -801,7 +926,6 @@ ApiDocumentContent.prototype.GetClassType = function(){ return ""; }; /** * Returns a number of elements in the current document. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {number} */ ApiDocumentContent.prototype.GetElementsCount = function(){ return 0; }; @@ -810,7 +934,6 @@ ApiDocumentContent.prototype.GetElementsCount = function(){ return 0; }; * Returns an element by its position in the document. * @memberof ApiDocumentContent * @param {number} nPos - The element position that will be taken from the document. - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {DocumentElement} */ ApiDocumentContent.prototype.GetElement = function(nPos){ return new DocumentElement(); }; @@ -818,16 +941,15 @@ ApiDocumentContent.prototype.GetElement = function(nPos){ return new DocumentEle /** * Adds a paragraph or a table or a blockLvl content control using its position in the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The position where the current element will be added. * @param {DocumentElement} oElement - The document element which will be added at the current position. + * @returns {boolean} */ -ApiDocumentContent.prototype.AddElement = function(nPos, oElement){}; +ApiDocumentContent.prototype.AddElement = function(nPos, oElement){ return true; }; /** * Pushes a paragraph or a table to actually add it to the document. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {DocumentElement} oElement - The element type which will be pushed to the document. * @returns {boolean} - returns false if oElement is unsupported. */ @@ -838,46 +960,60 @@ ApiDocumentContent.prototype.Push = function(oElement){ return true; }; * When all elements are removed, a new empty paragraph is automatically created. If you want to add * content to this paragraph, use the {@link ApiDocumentContent#GetElement} method. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiDocumentContent.prototype.RemoveAllElements = function(){}; +ApiDocumentContent.prototype.RemoveAllElements = function(){ return true; }; /** * Removes an element using the position specified. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The element number (position) in the document or inside other element. + * @returns {boolean} */ -ApiDocumentContent.prototype.RemoveElement = function(nPos){}; +ApiDocumentContent.prototype.RemoveElement = function(nPos){ return true; }; /** - * Creates a new history point. - * @memberof ApiDocument + * Represents an attribute of an XML node. + * @typedef {Object} CustomXmlNodeAttribute + * @property {string} name - The attribute name. + * @property {string} value - The attribute value. */ -ApiDocument.prototype.CreateNewHistoryPoint = function(){}; /** - * Record of one comment. + * Represents a single comment record. * @typedef {Object} CommentReportRecord - * @property {boolean} [IsAnswer=false] - Specifies whether this is an initial comment or a reply to another comment. - * @property {string} CommentMessage - The text of the current comment. - * @property {number} Date - The time when this change was made in local time. - * @property {number} DateUTC - The time when this change was made in UTC. - * @property {string} [QuoteText=undefined] - The text to which this comment is related. + * @property {boolean} IsAnswer Specifies whether the comment is a response. + * @property {string} CommentMessage The comment text. + * @property {number} Date The comment local timestamp. + * @property {number} DateUTC The comment UTC timestamp. + * @property {string} [QuoteText] The quoted text (if available). */ /** - * Report on all comments. - * This is a dictionary where the keys are usernames. - * @typedef {Object.>} CommentReport + * Represents a user's comment history. + * @typedef {Object} UserComments + * @property {CommentReportRecord[]} comments A list of comments. + */ + +/** + * A dictionary of users and their comments. + * @typedef {Object} CommentReport + * @property {UserComments} [username] The comments grouped by username. * @example - * { - * "John Smith" : [{IsAnswer: false, CommentMessage: 'Good text', Date: 1688588002698, DateUTC: 1688570002698, QuoteText: 'Some text'}, - * {IsAnswer: true, CommentMessage: "I don't think so", Date: 1688588012661, DateUTC: 1688570012661}], - * - * "Mark Pottato" : [{IsAnswer: false, CommentMessage: 'Need to change this part', Date: 1688587967245, DateUTC: 1688569967245, QuoteText: 'The quick brown fox jumps over the lazy dog'}, - * {IsAnswer: false, CommentMessage: 'We need to add a link', Date: 1688587967245, DateUTC: 1688569967245, QuoteText: 'OnlyOffice'}] - * } + * { + * "John Smith": { + * comments: [ + * { IsAnswer: false, CommentMessage: "Good text", Date: 1688588002698, DateUTC: 1688570002698, QuoteText: "Some text" }, + * { IsAnswer: true, CommentMessage: "I don't think so", Date: 1688588012661, DateUTC: 1688570012661 } + * ] + * }, + * "Mark Pottato": { + * comments: [ + * { IsAnswer: false, CommentMessage: "Need to change this part", Date: 1688587967245, DateUTC: 1688569967245, QuoteText: "The quick brown fox jumps over the lazy dog" }, + * { IsAnswer: false, CommentMessage: "We need to add a link", Date: 1688587967245, DateUTC: 1688569967245, QuoteText: "OnlyOffice" } + * ] + * } + * } */ /** @@ -886,23 +1022,38 @@ ApiDocument.prototype.CreateNewHistoryPoint = function(){}; */ /** - * Record of one review change. + * Represents a single review change record. * @typedef {Object} ReviewReportRecord - * @property {ReviewReportRecordType} Type - Review record type. - * @property {string} [Value=undefined] - Review change value that is set for the "TextAdd" and "TextRem" types only. - * @property {number} Date - The time when this change was made. + * @property {ReviewReportRecordType} Type The review record type. + * @property {string} [Value] The review change value (only for "TextAdd" and "TextRem" types). + * @property {number} Date The timestamp of the change. + * @property {ApiParagraph | ApiTable} ReviewedElement The element that was reviewed. */ /** - * Report on all review changes. - * This is a dictionary where the keys are usernames. - * @typedef {Object.>} ReviewReport + * Represents a user's review history. + * @typedef {Object} UserReviewChanges + * @property {ReviewReportRecord[]} reviews A list of review records. + */ + +/** + * A dictionary of users and their review changes. + * @typedef {Object} ReviewReport + * @property {UserReviewChanges} [username] The review changes grouped by username. * @example * { - * "John Smith" : [{Type: 'TextRem', Value: 'Hello, Mark!', Date: 1679941734161}, - * {Type: 'TextAdd', Value: 'Dear Mr. Pottato.', Date: 1679941736189}], - * "Mark Pottato" : [{Type: 'ParaRem', Date: 1679941755942}, - * {Type: 'TextPr', Date: 1679941757832}] + * "John Smith": { + * reviews: [ + * { Type: "TextRem", Value: "Hello, Mark!", Date: 1679941734161, ReviewedElement: ApiParagraph }, + * { Type: "TextAdd", Value: "Dear Mr. Pottato.", Date: 1679941736189, ReviewedElement: ApiParagraph } + * ] + * }, + * "Mark Pottato": { + * reviews: [ + * { Type: "ParaRem", Date: 1679941755942, ReviewedElement: ApiParagraph }, + * { Type: "TextPr", Date: 1679941757832, ReviewedElement: ApiParagraph } + * ] + * } * } */ @@ -930,7 +1081,6 @@ ApiDocument.prototype.CreateNewHistoryPoint = function(){}; /** * Returns a type of the ApiParagraph class. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"paragraph"} */ ApiParagraph.prototype.GetClassType = function(){ return ""; }; @@ -938,7 +1088,6 @@ ApiParagraph.prototype.GetClassType = function(){ return ""; }; /** * Adds some text to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} [sText=""] - The text that we want to insert into the current document element. * @returns {ApiRun} */ @@ -947,7 +1096,6 @@ ApiParagraph.prototype.AddText = function(sText){ return new ApiRun(); }; /** * Adds a line break to the current position and starts the next element from a new line. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddLineBreak = function(){ return new ApiRun(); }; @@ -955,7 +1103,6 @@ ApiParagraph.prototype.AddLineBreak = function(){ return new ApiRun(); }; /** * Returns the paragraph properties. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParaPr} */ ApiParagraph.prototype.GetParaPr = function(){ return new ApiParaPr(); }; @@ -963,7 +1110,6 @@ ApiParagraph.prototype.GetParaPr = function(){ return new ApiParaPr(); }; /** * Returns a number of elements in the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {number} */ ApiParagraph.prototype.GetElementsCount = function(){ return 0; }; @@ -971,7 +1117,6 @@ ApiParagraph.prototype.GetElementsCount = function(){ return 0; }; /** * Returns a paragraph element using the position specified. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The position where the element which content we want to get must be located. * @returns {ParagraphContent} */ @@ -983,24 +1128,23 @@ ApiParagraph.prototype.GetElement = function(nPos){ return new ParagraphContent( * a new empty run is automatically created. If you want to add * content to this run, use the {@link ApiParagraph#GetElement} method. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The element position which we want to remove from the paragraph. + * @returns {boolean} */ -ApiParagraph.prototype.RemoveElement = function(nPos){}; +ApiParagraph.prototype.RemoveElement = function(nPos){ return true; }; /** * Removes all the elements from the current paragraph. * When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add * content to this run, use the {@link ApiParagraph#GetElement} method. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiParagraph.prototype.RemoveAllElements = function(){}; +ApiParagraph.prototype.RemoveAllElements = function(){ return true; }; /** * Deletes the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} - returns false if paragraph haven't parent. */ ApiParagraph.prototype.Delete = function(){ return true; }; @@ -1008,7 +1152,6 @@ ApiParagraph.prototype.Delete = function(){ return true; }; /** * Returns the next paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph | null} - returns null if paragraph is last. */ ApiParagraph.prototype.GetNext = function(){ return new ApiParagraph(); }; @@ -1016,7 +1159,6 @@ ApiParagraph.prototype.GetNext = function(){ return new ApiParagraph(); }; /** * Returns the previous paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph} - returns null if paragraph is first. */ ApiParagraph.prototype.GetPrevious = function(){ return new ApiParagraph(); }; @@ -1024,7 +1166,6 @@ ApiParagraph.prototype.GetPrevious = function(){ return new ApiParagraph(); }; /** * Creates a paragraph copy. Ingnore comments, footnote references, complex fields. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph} */ ApiParagraph.prototype.Copy = function(){ return new ApiParagraph(); }; @@ -1032,7 +1173,6 @@ ApiParagraph.prototype.Copy = function(){ return new ApiParagraph(); }; /** * Adds an element to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ParagraphContent} oElement - The document element which will be added at the current position. Returns false if the * oElement type is not supported by a paragraph. * @param {number} [nPos] - The position where the current element will be added. If this value is not @@ -1045,7 +1185,6 @@ ApiParagraph.prototype.AddElement = function(oElement, nPos){ return true; }; /** * Adds a tab stop to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddTabStop = function(){ return new ApiRun(); }; @@ -1053,7 +1192,6 @@ ApiParagraph.prototype.AddTabStop = function(){ return new ApiRun(); }; /** * Specifies a highlighting color which is applied as a background to the contents of the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CPE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiParagraph} this */ @@ -1062,7 +1200,6 @@ ApiParagraph.prototype.SetHighlight = function(sColor){ return new ApiParagraph( /** * Returns a type of the ApiRun class. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"run"} */ ApiRun.prototype.GetClassType = function(){ return ""; }; @@ -1070,7 +1207,6 @@ ApiRun.prototype.GetClassType = function(){ return ""; }; /** * Returns the text properties of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiTextPr} */ ApiRun.prototype.GetTextPr = function(){ return new ApiTextPr(); }; @@ -1078,50 +1214,49 @@ ApiRun.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** * Clears the content from the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.ClearContent = function(){}; +ApiRun.prototype.ClearContent = function(){ return true; }; /** * Removes all the elements from the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.RemoveAllElements = function(){}; +ApiRun.prototype.RemoveAllElements = function(){ return true; }; /** * Deletes the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.Delete = function(){}; +ApiRun.prototype.Delete = function(){ return true; }; /** * Adds some text to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sText - The text which will be added to the current run. + * @returns {boolean} */ -ApiRun.prototype.AddText = function(sText){}; +ApiRun.prototype.AddText = function(sText){ return true; }; /** * Adds a line break to the current run position and starts the next element from a new line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.AddLineBreak = function(){}; +ApiRun.prototype.AddLineBreak = function(){ return true; }; /** * Adds a tab stop to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.AddTabStop = function(){}; +ApiRun.prototype.AddTabStop = function(){ return true; }; /** * Creates a copy of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiRun.prototype.Copy = function(){ return new ApiRun(); }; @@ -1129,7 +1264,6 @@ ApiRun.prototype.Copy = function(){ return new ApiRun(); }; /** * Sets the text properties to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ApiTextPr} oTextPr - The text properties that will be set to the current run. * @returns {ApiTextPr} */ @@ -1138,7 +1272,6 @@ ApiRun.prototype.SetTextPr = function(oTextPr){ return new ApiTextPr(); }; /** * Sets the bold property to the text character. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isBold - Specifies that the contents of the current run are displayed bold. * @returns {ApiTextPr} */ @@ -1147,7 +1280,6 @@ ApiRun.prototype.SetBold = function(isBold){ return new ApiTextPr(); }; /** * Specifies that any lowercase characters in the current text run are formatted for display only as their capital letter character equivalents. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isCaps - Specifies that the contents of the current run are displayed capitalized. * @returns {ApiTextPr} */ @@ -1156,7 +1288,6 @@ ApiRun.prototype.SetCaps = function(isCaps){ return new ApiTextPr(); }; /** * Sets the text color for the current text run in the RGB format. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -1168,7 +1299,6 @@ ApiRun.prototype.SetColor = function(r, g, b, isAuto){ return new ApiTextPr(); } /** * Specifies that the contents of the current run are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isDoubleStrikeout - Specifies that the contents of the current run are displayed double struck through. * @returns {ApiTextPr} */ @@ -1177,7 +1307,6 @@ ApiRun.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return new Ap /** * Sets the text color to the current text run. * @memberof ApiRun - * @typeofeditors ["CSE", "CPE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the text color. * @returns {ApiTextPr} */ @@ -1186,7 +1315,6 @@ ApiRun.prototype.SetFill = function(oApiFill){ return new ApiTextPr(); }; /** * Sets all 4 font slots with the specified font family. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sFontFamily - The font family or families used for the current text run. * @returns {ApiTextPr} */ @@ -1195,7 +1323,6 @@ ApiRun.prototype.SetFontFamily = function(sFontFamily){ return new ApiTextPr(); /** * Returns all font names from all elements inside the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {string[]} - The font names used for the current run. */ ApiRun.prototype.GetFontNames = function(){ return [""]; }; @@ -1203,7 +1330,6 @@ ApiRun.prototype.GetFontNames = function(){ return [""]; }; /** * Sets the font size to the characters of the current text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiTextPr} */ @@ -1212,7 +1338,6 @@ ApiRun.prototype.SetFontSize = function(nSize){ return new ApiTextPr(); }; /** * Specifies a highlighting color which is applied as a background to the contents of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiTextPr} */ @@ -1221,7 +1346,6 @@ ApiRun.prototype.SetHighlight = function(sColor){ return new ApiTextPr(); }; /** * Sets the italic property to the text character. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isItalic - Specifies that the contents of the current run are displayed italicized. * @returns {ApiTextPr} */ @@ -1231,7 +1355,6 @@ ApiRun.prototype.SetItalic = function(isItalic){ return new ApiTextPr(); }; * Specifies the languages which will be used to check spelling and grammar (if requested) when processing * the contents of this text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sLangId - The possible value for this parameter is a language identifier as defined by * RFC 4646/BCP 47. Example: "en-CA". * @returns {ApiTextPr} @@ -1242,7 +1365,6 @@ ApiRun.prototype.SetLanguage = function(sLangId){ return new ApiTextPr(); }; * Specifies an amount by which text is raised or lowered for this run in relation to the default * baseline of the surrounding non-positioned text. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nPosition - Specifies a positive (raised text) or negative (lowered text) * measurement in half-points (1/144 of an inch). * @returns {ApiTextPr} @@ -1252,7 +1374,6 @@ ApiRun.prototype.SetPosition = function(nPosition){ return new ApiTextPr(); }; /** * Specifies the shading applied to the contents of the current text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ShdType} sType - The shading type applied to the contents of the current text run. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. @@ -1265,7 +1386,6 @@ ApiRun.prototype.SetShd = function(sType, r, g, b){ return new ApiTextPr(); }; * Specifies that all the small letter characters in this text run are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current run are displayed capitalized two points smaller or not. * @returns {ApiTextPr} */ @@ -1274,7 +1394,6 @@ ApiRun.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiTextPr(); } /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiTextPr} */ @@ -1283,26 +1402,15 @@ ApiRun.prototype.SetSpacing = function(nSpacing){ return new ApiTextPr(); }; /** * Specifies that the contents of the current run are displayed with a single horizontal line through the center of the line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isStrikeout - Specifies that the contents of the current run are displayed struck through. * @returns {ApiTextPr} */ ApiRun.prototype.SetStrikeout = function(isStrikeout){ return new ApiTextPr(); }; -/** - * Sets a style to the current run. - * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiStyle} oStyle - The style which must be applied to the text run. - * @returns {ApiTextPr} - */ -ApiRun.prototype.SetStyle = function(oStyle){ return new ApiTextPr(); }; - /** * Specifies that the contents of the current run are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isUnderline - Specifies that the contents of the current run are displayed underlined. * @returns {ApiTextPr} */ @@ -1310,20 +1418,32 @@ ApiRun.prototype.SetUnderline = function(isUnderline){ return new ApiTextPr(); } /** * Specifies the alignment which will be applied to the contents of the current run in relation to the default appearance of the text run: - * * "baseline" - the characters in the current text run will be aligned by the default text baseline. - * * "subscript" - the characters in the current text run will be aligned below the default text baseline. - * * "superscript" - the characters in the current text run will be aligned above the default text baseline. + * "baseline" - the characters in the current text run will be aligned by the default text baseline. + * "subscript" - the characters in the current text run will be aligned below the default text baseline. + * "superscript" - the characters in the current text run will be aligned above the default text baseline. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiTextPr} */ ApiRun.prototype.SetVertAlign = function(sType){ return new ApiTextPr(); }; +/** + * The section break type which defines how the contents of the current section are placed relative to the previous section. + * WordprocessingML supports five distinct types of section breaks: + * Next page ("nextPage") - starts a new section on the next page (the default value). + * Odd ("oddPage") - starts a new section on the next odd-numbered page. + * Even ("evenPage") - starts a new section on the next even-numbered page. + * Continuous ("continuous") - starts a new section in the next paragraph. + * This means that continuous section breaks might not specify certain page-level section properties, + * since they shall be inherited from the following section. + * However, these breaks can specify other section properties, such as line numbering and footnote/endnote settings. + * Column ("nextColumn") - starts a new section in the next column on the page. + * @typedef {("nextPage" | "oddPage" | "evenPage" | "continuous" | "nextColumn")} SectionBreakType +*/ + /** * Returns a type of the ApiTextPr class. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"textPr"} */ ApiTextPr.prototype.GetClassType = function(){ return ""; }; @@ -1331,7 +1451,6 @@ ApiTextPr.prototype.GetClassType = function(){ return ""; }; /** * Sets the bold property to the text character. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isBold - Specifies that the contents of the run are displayed bold. * @returns {ApiTextPr} - this text properties. */ @@ -1340,7 +1459,6 @@ ApiTextPr.prototype.SetBold = function(isBold){ return new ApiTextPr(); }; /** * Gets the bold property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1349,7 +1467,6 @@ ApiTextPr.prototype.GetBold = function(){ return true; }; /** * Sets the italic property to the text character. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isItalic - Specifies that the contents of the current run are displayed italicized. * @returns {ApiTextPr} - this text properties. */ @@ -1358,7 +1475,6 @@ ApiTextPr.prototype.SetItalic = function(isItalic){ return new ApiTextPr(); }; /** * Gets the italic property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1367,7 +1483,6 @@ ApiTextPr.prototype.GetItalic = function(){ return true; }; /** * Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isStrikeout - Specifies that the contents of the current run are displayed struck through. * @returns {ApiTextPr} - this text properties. */ @@ -1376,7 +1491,6 @@ ApiTextPr.prototype.SetStrikeout = function(isStrikeout){ return new ApiTextPr() /** * Gets the strikeout property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1386,7 +1500,6 @@ ApiTextPr.prototype.GetStrikeout = function(){ return true; }; * Specifies that the contents of the run are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isUnderline - Specifies that the contents of the current run are displayed underlined. * @returns {ApiTextPr} - this text properties. */ @@ -1395,7 +1508,6 @@ ApiTextPr.prototype.SetUnderline = function(isUnderline){ return new ApiTextPr() /** * Gets the underline property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1404,25 +1516,25 @@ ApiTextPr.prototype.GetUnderline = function(){ return true; }; /** * Sets all 4 font slots with the specified font family. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sFontFamily - The font family or families used for the current text run. * @returns {ApiTextPr} - this text properties. */ ApiTextPr.prototype.SetFontFamily = function(sFontFamily){ return new ApiTextPr(); }; /** - * Gets the font family from the current text properties. + * Returns the font family from the current text properties. + * The method automatically calculates the font from the theme if the font was set via the theme. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] + * param {undefined | "ascii" | "eastAsia" | "hAnsi" | "cs"} [fontSlot="ascii"] - The font slot. + * If this parameter is not specified, the "ascii" value is used. * @returns {string} * @since 8.1.0 */ -ApiTextPr.prototype.GetFontFamily = function(){ return ""; }; +ApiTextPr.prototype.GetFontFamily = function(fontSlot){ return ""; }; /** * Sets the font size to the characters of the current text run. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiTextPr} - this text properties. */ @@ -1431,7 +1543,6 @@ ApiTextPr.prototype.SetFontSize = function(nSize){ return new ApiTextPr(); }; /** * Gets the font size from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {hps} * @since 8.1.0 */ @@ -1439,11 +1550,10 @@ ApiTextPr.prototype.GetFontSize = function(){ return new hps(); }; /** * Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text: - * * "baseline" - the characters in the current text run will be aligned by the default text baseline. - * * "subscript" - the characters in the current text run will be aligned below the default text baseline. - * * "superscript" - the characters in the current text run will be aligned above the default text baseline. + * "baseline" - the characters in the current text run will be aligned by the default text baseline. + * "subscript" - the characters in the current text run will be aligned below the default text baseline. + * "superscript" - the characters in the current text run will be aligned above the default text baseline. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiTextPr} - this text properties. */ @@ -1452,7 +1562,6 @@ ApiTextPr.prototype.SetVertAlign = function(sType){ return new ApiTextPr(); }; /** * Specifies a highlighting color which is added to the text properties and applied as a background to the contents of the current run/range/paragraph. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CPE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiTextPr} */ @@ -1461,7 +1570,6 @@ ApiTextPr.prototype.SetHighlight = function(sColor){ return new ApiTextPr(); }; /** * Gets the highlight property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CPE"] * @returns {string} * @since 8.1.0 */ @@ -1470,7 +1578,6 @@ ApiTextPr.prototype.GetHighlight = function(){ return ""; }; /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiTextPr} - this text properties. */ @@ -1479,7 +1586,6 @@ ApiTextPr.prototype.SetSpacing = function(nSpacing){ return new ApiTextPr(); }; /** * Gets the text spacing from the current text properties measured in twentieths of a point. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} * @since 8.1.0 */ @@ -1488,7 +1594,6 @@ ApiTextPr.prototype.GetSpacing = function(){ return new twips(); }; /** * Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isDoubleStrikeout - Specifies that the contents of the current run are displayed double struck through. * @returns {ApiTextPr} - this text properties. */ @@ -1497,7 +1602,6 @@ ApiTextPr.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return new /** * Gets the double strikeout property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1506,7 +1610,6 @@ ApiTextPr.prototype.GetDoubleStrikeout = function(){ return true; }; /** * Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isCaps - Specifies that the contents of the current run are displayed capitalized. * @returns {ApiTextPr} - this text properties. */ @@ -1515,7 +1618,6 @@ ApiTextPr.prototype.SetCaps = function(isCaps){ return new ApiTextPr(); }; /** * Specifies whether the text with the current text properties are capitalized. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1525,7 +1627,6 @@ ApiTextPr.prototype.GetCaps = function(){ return true; }; * Specifies that all the small letter characters in the text run are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current run are displayed capitalized two points smaller or not. * @returns {ApiTextPr} - this text properties. */ @@ -1534,7 +1635,6 @@ ApiTextPr.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiTextPr() /** * Specifies whether the text with the current text properties are displayed capitalized two points smaller than the actual font size. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -1543,7 +1643,6 @@ ApiTextPr.prototype.GetSmallCaps = function(){ return true; }; /** * Sets the text color to the current text run. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the text color. * @returns {ApiTextPr} - this text properties. */ @@ -1552,7 +1651,6 @@ ApiTextPr.prototype.SetFill = function(oApiFill){ return new ApiTextPr(); }; /** * Gets the text color from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @returns {ApiFill} * @since 8.1.0 */ @@ -1561,7 +1659,6 @@ ApiTextPr.prototype.GetFill = function(){ return new ApiFill(); }; /** * Sets the text fill to the current text run. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE", "CSE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the text color. * @returns {ApiTextPr} - this text properties. */ @@ -1570,7 +1667,6 @@ ApiTextPr.prototype.SetTextFill = function(oApiFill){ return new ApiTextPr(); }; /** * Gets the text fill from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @returns {ApiFill} * @since 8.1.0 */ @@ -1579,7 +1675,6 @@ ApiTextPr.prototype.GetTextFill = function(){ return new ApiFill(); }; /** * Sets the text outline to the current text run. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the text outline. * @returns {ApiTextPr} - this text properties. */ @@ -1588,7 +1683,6 @@ ApiTextPr.prototype.SetOutLine = function(oStroke){ return new ApiTextPr(); }; /** * Gets the text outline from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CSE", "CPE"] * @returns {ApiStroke} * @since 8.1.0 */ @@ -1597,7 +1691,6 @@ ApiTextPr.prototype.GetOutLine = function(){ return new ApiStroke(); }; /** * Returns a type of the ApiParaPr class. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"paraPr"} */ ApiParaPr.prototype.GetClassType = function(){ return ""; }; @@ -1605,15 +1698,14 @@ ApiParaPr.prototype.GetClassType = function(){ return ""; }; /** * Sets the paragraph left side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph left side indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndLeft = function(nValue){}; +ApiParaPr.prototype.SetIndLeft = function(nValue){ return true; }; /** * Returns the paragraph left side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph left side indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndLeft = function(){ return new twips(); }; @@ -1621,15 +1713,14 @@ ApiParaPr.prototype.GetIndLeft = function(){ return new twips(); }; /** * Sets the paragraph right side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph right side indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndRight = function(nValue){}; +ApiParaPr.prototype.SetIndRight = function(nValue){ return true; }; /** * Returns the paragraph right side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph right side indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndRight = function(){ return new twips(); }; @@ -1637,15 +1728,14 @@ ApiParaPr.prototype.GetIndRight = function(){ return new twips(); }; /** * Sets the paragraph first line indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph first line indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndFirstLine = function(nValue){}; +ApiParaPr.prototype.SetIndFirstLine = function(nValue){ return true; }; /** * Returns the paragraph first line indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph first line indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndFirstLine = function(){ return new twips(); }; @@ -1653,16 +1743,15 @@ ApiParaPr.prototype.GetIndFirstLine = function(){ return new twips(); }; /** * Sets the paragraph contents justification. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("left" | "right" | "both" | "center")} sJc - The justification type that * will be applied to the paragraph contents. + * @returns {boolean} */ -ApiParaPr.prototype.SetJc = function(sJc){}; +ApiParaPr.prototype.SetJc = function(sJc){ return true; }; /** * Returns the paragraph contents justification. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {("left" | "right" | "both" | "center" | undefined)} */ ApiParaPr.prototype.GetJc = function(){ return ""; }; @@ -1673,16 +1762,15 @@ ApiParaPr.prototype.GetJc = function(){ return ""; }; * the value of the sLineRule parameter is "auto", then the value of the * nLine parameter will be interpreted as 240ths of a line. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {(twips | line240)} nLine - The line spacing value measured either in twentieths of a point (1/1440 of an inch) or in 240ths of a line. * @param {("auto" | "atLeast" | "exact")} sLineRule - The rule that determines the measuring units of the line spacing. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingLine = function(nLine, sLineRule){}; +ApiParaPr.prototype.SetSpacingLine = function(nLine, sLineRule){ return true; }; /** * Returns the paragraph line spacing value. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | line240 | undefined} - to know is twips or line240 use ApiParaPr.prototype.GetSpacingLineRule(). */ ApiParaPr.prototype.GetSpacingLineValue = function(){ return new twips(); }; @@ -1690,7 +1778,6 @@ ApiParaPr.prototype.GetSpacingLineValue = function(){ return new twips(); }; /** * Returns the paragraph line spacing rule. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"auto" | "atLeast" | "exact" | undefined} */ ApiParaPr.prototype.GetSpacingLineRule = function(){ return ""; }; @@ -1700,16 +1787,15 @@ ApiParaPr.prototype.GetSpacingLineRule = function(){ return ""; }; * any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then * it will be interpreted as false. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nBefore - The value of the spacing before the current paragraph measured in twentieths of a point (1/1440 of an inch). * @param {boolean} [isBeforeAuto=false] - The true value disables the spacing before the current paragraph. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingBefore = function(nBefore, isBeforeAuto){}; +ApiParaPr.prototype.SetSpacingBefore = function(nBefore, isBeforeAuto){ return true; }; /** * Returns the spacing before value of the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} - The value of the spacing before the current paragraph measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetSpacingBefore = function(){ return new twips(); }; @@ -1719,16 +1805,15 @@ ApiParaPr.prototype.GetSpacingBefore = function(){ return new twips(); }; * any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it * will be interpreted as false. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nAfter - The value of the spacing after the current paragraph measured in twentieths of a point (1/1440 of an inch). * @param {boolean} [isAfterAuto=false] - The true value disables the spacing after the current paragraph. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingAfter = function(nAfter, isAfterAuto){}; +ApiParaPr.prototype.SetSpacingAfter = function(nAfter, isAfterAuto){ return true; }; /** * Returns the spacing after value of the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} - The value of the spacing after the current paragraph measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetSpacingAfter = function(){ return new twips(); }; @@ -1737,26 +1822,451 @@ ApiParaPr.prototype.GetSpacingAfter = function(){ return new twips(); }; * Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph. * Warning: The lengths of aPos array and aVal array MUST BE equal to each other. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips[]} aPos - An array of the positions of custom tab stops with respect to the current page margins * measured in twentieths of a point (1/1440 of an inch). * @param {TabJc[]} aVal - An array of the styles of custom tab stops, which determines the behavior of the tab * stop and the alignment which will be applied to text entered at the current custom tab stop. + * @returns {boolean} */ -ApiParaPr.prototype.SetTabs = function(aPos, aVal){}; +ApiParaPr.prototype.SetTabs = function(aPos, aVal){ return true; }; /** * Sets the bullet or numbering to the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CSE", "CPE"] * @param {?ApiBullet} oBullet - The bullet object created with the {@link Api#CreateBullet} or {@link Api#CreateNumbering} method. */ ApiParaPr.prototype.SetBullet = function(oBullet){}; +/** + * Sets the outline level for the specified properties. + * @memberof ApiParaPr + * @param {Number} [nLvl=undefined] - The outline level. Possible values: 0-8. The 0 value means the basic outline level. + * To set no outline level, use this method without a parameter. + * @returns {boolean} + * @since 8.2.0 + */ +ApiParaPr.prototype.SetOutlineLvl = function(nLvl){ return true; }; + +/** + * Returns the outline level of the specified properties. + * @memberof ApiParaPr + * @returns {Number} + * @since 8.2.0 + */ +ApiParaPr.prototype.GetOutlineLvl = function(){ return 0; }; + +/** + * Returns a type of the ApiChart class. + * @memberof ApiChart + * @returns {"chart"} + */ +ApiChart.prototype.GetClassType = function(){ return ""; }; + +/** + * Returns a type of the chart object. + * @memberof ApiChart + * @returns {ChartType} + */ +ApiChart.prototype.GetChartType = function(){ return new ChartType(); }; + +/** + * Specifies the chart title. + * @memberof ApiChart + * @param {string} sTitle - The title which will be displayed for the current chart. + * @param {pt} nFontSize - The text size value measured in points. + * @param {boolean} bIsBold - Specifies if the chart title is written in bold font or not. + * @returns {boolean} + */ +ApiChart.prototype.SetTitle = function (sTitle, nFontSize, bIsBold){ return true; }; + +/** + * Specifies the chart horizontal axis title. + * @memberof ApiChart + * @param {string} sTitle - The title which will be displayed for the horizontal axis of the current chart. + * @param {pt} nFontSize - The text size value measured in points. + * @param {boolean} bIsBold - Specifies if the horizontal axis title is written in bold font or not. + *@returns {boolean} + */ +ApiChart.prototype.SetHorAxisTitle = function (sTitle, nFontSize, bIsBold){ return true; }; + +/** + * Specifies the chart vertical axis title. + * @memberof ApiChart + * @param {string} sTitle - The title which will be displayed for the vertical axis of the current chart. + * @param {pt} nFontSize - The text size value measured in points. + * @param {boolean} bIsBold - Specifies if the vertical axis title is written in bold font or not. + *@returns {boolean} + */ +ApiChart.prototype.SetVerAxisTitle = function (sTitle, nFontSize, bIsBold){ return true; }; + +/** + * Specifies the vertical axis orientation. + * @memberof ApiChart + * @param {boolean} bIsMinMax - The true value will set the normal data direction for the vertical axis (from minimum to maximum). + * @returns {boolean} + */ +ApiChart.prototype.SetVerAxisOrientation = function(bIsMinMax){ return true; }; + +/** + * Specifies the horizontal axis orientation. + * @memberof ApiChart + * @param {boolean} bIsMinMax - The true value will set the normal data direction for the horizontal axis (from minimum to maximum). + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisOrientation = function(bIsMinMax){ return true; }; + +/** + * Specifies the chart legend position. + * @memberof ApiChart + * @param {"left" | "top" | "right" | "bottom" | "none"} sLegendPos - The position of the chart legend inside the chart window. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendPos = function(sLegendPos){ return true; }; + +/** + * Specifies the legend font size. + * @memberof ApiChart + * @param {pt} nFontSize - The text size value measured in points. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendFontSize = function(nFontSize){ return true; }; + +/** + * Specifies which chart data labels are shown for the chart. + * @memberof ApiChart + * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. + * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. + * @param {boolean} bShowVal - Whether to show or hide the chart data values. + * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). + * @returns {boolean} + */ +ApiChart.prototype.SetShowDataLabels = function(bShowSerName, bShowCatName, bShowVal, bShowPercent){ return true; }; + +/** + * Spicifies the show options for data labels. + * @memberof ApiChart + * @param {number} nSeriesIndex - The series index from the array of the data used to build the chart from. + * @param {number} nPointIndex - The point index from this series. + * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. + * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. + * @param {boolean} bShowVal - Whether to show or hide the chart data values. + * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). + * @returns {boolean} + */ +ApiChart.prototype.SetShowPointDataLabel = function(nSeriesIndex, nPointIndex, bShowSerName, bShowCatName, bShowVal, bShowPercent){ return true; }; + +/** + * Spicifies tick labels position for the vertical axis. + * @memberof ApiChart + * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart vertical tick labels. + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisTickLabelPosition = function(sTickLabelPosition){ return true; }; + +/** + * Spicifies tick labels position for the horizontal axis. + * @memberof ApiChart + * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart horizontal tick labels. + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisTickLabelPosition = function(sTickLabelPosition){ return true; }; + +/** + * Specifies major tick mark for the horizontal axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisMajorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies minor tick mark for the horizontal axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisMinorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies major tick mark for the vertical axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisMajorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies minor tick mark for the vertical axis. + * @memberof ApiChart + * @param {TickMark} sTickMark - The type of tick mark appearance. + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisMinorTickMark = function(sTickMark){ return true; }; + +/** + * Specifies major vertical gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMajorVerticalGridlines = function(oStroke){ return true; }; + +/** + * Specifies minor vertical gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMinorVerticalGridlines = function(oStroke){ return true; }; + +/** + * Specifies major horizontal gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMajorHorizontalGridlines = function(oStroke){ return true; }; + +/** + * Specifies minor horizontal gridline visual properties. + * @memberof ApiChart + * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. + * @returns {boolean} + */ +ApiChart.prototype.SetMinorHorizontalGridlines = function(oStroke){ return true; }; + +/** + * Removes the specified series from the current chart. + * @memberof ApiChart + * @param {number} nSeria - The index of the chart series. + * @returns {boolean} + */ +ApiChart.prototype.RemoveSeria = function(nSeria){ return true; }; + +/** + * Sets values to the specified chart series. + * @memberof ApiChart + * @param {number[]} aValues - The array of the data which will be set to the specified chart series. + * @param {number} nSeria - The index of the chart series. + * @returns {boolean} + */ +ApiChart.prototype.SetSeriaValues = function(aValues, nSeria){ return true; }; + +/** + * Sets the x-axis values to all chart series. It is used with the scatter charts only. + * @memberof ApiChart + * @param {string[]} aValues - The array of the data which will be set to the x-axis data points. + * @returns {boolean} + */ +ApiChart.prototype.SetXValues = function(aValues){ return true; }; + +/** + * Sets a name to the specified chart series. + * @memberof ApiChart + * @param {string} sName - The name which will be set to the specified chart series. + * @param {number} nSeria - The index of the chart series. + * @returns {boolean} + */ +ApiChart.prototype.SetSeriaName = function(sName, nSeria){ return true; }; + +/** + * Sets a name to the specified chart category. + * @memberof ApiChart + * @param {string} sName - The name which will be set to the specified chart category. + * @param {number} nCategory - The index of the chart category. + * @returns {boolean} + */ +ApiChart.prototype.SetCategoryName = function(sName, nCategory){ return true; }; + +/** + * Sets a style to the current chart by style ID. + * @memberof ApiChart + * @param nStyleId - One of the styles available in the editor. + * @returns {boolean} + */ +ApiChart.prototype.ApplyChartStyle = function(nStyleId){ return true; }; + +/** + * Sets the fill to the chart plot area. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the plot area. + * @returns {boolean} + */ +ApiChart.prototype.SetPlotAreaFill = function(oFill){ return true; }; + +/** + * Sets the outline to the chart plot area. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the plot area outline. + * @returns {boolean} + */ +ApiChart.prototype.SetPlotAreaOutLine = function(oStroke){ return true; }; + +/** + * Sets the fill to the specified chart series. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the series. + * @param {number} nSeries - The index of the chart series. + * @param {boolean} [bAll=false] - Specifies if the fill will be applied to all series. + * @returns {boolean} + */ +ApiChart.prototype.SetSeriesFill = function(oFill, nSeries, bAll){ return true; }; + +/** + * Sets the outline to the specified chart series. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the series outline. + * @param {number} nSeries - The index of the chart series. + * @param {boolean} [bAll=false] - Specifies if the outline will be applied to all series. + * @returns {boolean} + */ +ApiChart.prototype.SetSeriesOutLine = function(oStroke, nSeries, bAll){ return true; }; + +/** + * Sets the fill to the data point in the specified chart series. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the data point. + * @param {number} nSeries - The index of the chart series. + * @param {number} nDataPoint - The index of the data point in the specified chart series. + * @param {boolean} [bAllSeries=false] - Specifies if the fill will be applied to the specified data point in all series. + * @returns {boolean} + */ +ApiChart.prototype.SetDataPointFill = function(oFill, nSeries, nDataPoint, bAllSeries){ return true; }; + +/** + * Sets the outline to the data point in the specified chart series. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the data point outline. + * @param {number} nSeries - The index of the chart series. + * @param {number} nDataPoint - The index of the data point in the specified chart series. + * @param {boolean} bAllSeries - Specifies if the outline will be applied to the specified data point in all series. + * @returns {boolean} + */ +ApiChart.prototype.SetDataPointOutLine = function(oStroke, nSeries, nDataPoint, bAllSeries){ return true; }; + +/** + * Sets the fill to the marker in the specified chart series. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the marker. + * @param {number} nSeries - The index of the chart series. + * @param {number} nMarker - The index of the marker in the specified chart series. + * @param {boolean} [bAllMarkers=false] - Specifies if the fill will be applied to all markers in the specified chart series. + * @returns {boolean} + */ +ApiChart.prototype.SetMarkerFill = function(oFill, nSeries, nMarker, bAllMarkers){ return true; }; + +/** + * Sets the outline to the marker in the specified chart series. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the marker outline. + * @param {number} nSeries - The index of the chart series. + * @param {number} nMarker - The index of the marker in the specified chart series. + * @param {boolean} [bAllMarkers=false] - Specifies if the outline will be applied to all markers in the specified chart series. + * @returns {boolean} + */ +ApiChart.prototype.SetMarkerOutLine = function(oStroke, nSeries, nMarker, bAllMarkers){ return true; }; + +/** + * Sets the fill to the chart title. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the title. + * @returns {boolean} + */ +ApiChart.prototype.SetTitleFill = function(oFill){ return true; }; + +/** + * Sets the outline to the chart title. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the title outline. + * @returns {boolean} + */ +ApiChart.prototype.SetTitleOutLine = function(oStroke){ return true; }; + +/** + * Sets the fill to the chart legend. + * @memberof ApiChart + * @param {ApiFill} oFill - The fill type used to fill the legend. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendFill = function(oFill){ return true; }; + +/** + * Sets the outline to the chart legend. + * @memberof ApiChart + * @param {ApiStroke} oStroke - The stroke used to create the legend outline. + * @returns {boolean} + */ +ApiChart.prototype.SetLegendOutLine = function(oStroke){ return true; }; + +/** + * Sets the specified numeric format to the axis values. + * @memberof ApiChart + * @param {NumFormat | String} sFormat - Numeric format (can be custom format). + * @param {AxisPos} - Axis position in the chart. + * @returns {boolean} + */ +ApiChart.prototype.SetAxieNumFormat = function(sFormat, sAxiePos){ return true; }; + +/** + * Sets the specified numeric format to the chart series. + * @memberof ApiChart + * @param {NumFormat | String} sFormat - Numeric format (can be custom format). + * @param {Number} nSeria - Series index. + * @returns {boolean} + */ +ApiChart.prototype.SetSeriaNumFormat = function(sFormat, nSeria){ return true; }; + +/** + * Sets the specified numeric format to the chart data point. + * @memberof ApiChart + * @param {NumFormat | String} sFormat - Numeric format (can be custom format). + * @param {Number} nSeria - Series index. + * @param {number} nDataPoint - The index of the data point in the specified chart series. + * @param {boolean} bAllSeries - Specifies if the numeric format will be applied to the specified data point in all series. + * @returns {boolean} + */ +ApiChart.prototype.SetDataPointNumFormat = function(sFormat, nSeria, nDataPoint, bAllSeries){ return true; }; + +/** + * Returns all series from the chart space. + * @memberof ApiChart + * @returns {ApiChartSeries[]} + */ +ApiChart.prototype.GetAllSeries = function(){ return [new ApiChartSeries()]; }; + +/** + * Returns the series with a specific index. + * @memberof ApiChart + * @param {number} nIdx - Series index. + * @returns {ApiChartSeries} + */ +ApiChart.prototype.GetSeries = function(nIdx){ return new ApiChartSeries(); }; + +/** + * Returns a type of the ApiChartSeries class. + * @memberof ApiChartSeries + * @returns {"chartSeries"} + */ +ApiChartSeries.prototype.GetClassType = function(){ return ""; }; + +/** + * Tries to change the series type. Returns true if successful. + * @memberof ApiChartSeries + * @param {ChartType} sType - Chart type. + * @returns {boolean} + */ +ApiChartSeries.prototype.ChangeChartType = function(sType){ return true; }; + +/** + * Returns a chart type of the current series. + * @memberof ApiChartSeries + * @returns {ChartType} + */ +ApiChartSeries.prototype.GetChartType = function(){ return new ChartType(); }; + /** * Returns a type of the ApiFill class. * @memberof ApiFill - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"fill"} */ ApiFill.prototype.GetClassType = function(){ return ""; }; @@ -1764,7 +2274,6 @@ ApiFill.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the ApiStroke class. * @memberof ApiStroke - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"stroke"} */ ApiStroke.prototype.GetClassType = function(){ return ""; }; @@ -1772,7 +2281,6 @@ ApiStroke.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the ApiGradientStop class. * @memberof ApiGradientStop - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"gradientStop"} */ ApiGradientStop.prototype.GetClassType = function (){ return ""; }; @@ -1780,7 +2288,6 @@ ApiGradientStop.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiUniColor class. * @memberof ApiUniColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"uniColor"} */ ApiUniColor.prototype.GetClassType = function (){ return ""; }; @@ -1788,7 +2295,6 @@ ApiUniColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiRGBColor class. * @memberof ApiRGBColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"rgbColor"} */ ApiRGBColor.prototype.GetClassType = function (){ return ""; }; @@ -1796,7 +2302,6 @@ ApiRGBColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiSchemeColor class. * @memberof ApiSchemeColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"schemeColor"} */ ApiSchemeColor.prototype.GetClassType = function (){ return ""; }; @@ -1804,7 +2309,6 @@ ApiSchemeColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiPresetColor class. * @memberof ApiPresetColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"presetColor"} */ ApiPresetColor.prototype.GetClassType = function (){ return ""; }; @@ -1812,7 +2316,6 @@ ApiPresetColor.prototype.GetClassType = function (){ return ""; }; /** * Returns a type of the ApiBullet class. * @memberof ApiBullet - * @typeofeditors ["CSE", "CPE"] * @returns {"bullet"} */ ApiBullet.prototype.GetClassType = function(){ return ""; }; @@ -1820,33 +2323,30 @@ ApiBullet.prototype.GetClassType = function(){ return ""; }; /** * Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} arrString - An array of replacement strings. - * @param {string} [sParaTab=" "] - A character which is used to specify the tab in the source text. - * @param {string} [sParaNewLine=" "] - A character which is used to specify the line break character in the source text. + * @param {string[]} textStrings - An array of replacement strings. + * @param {string} [tab="\t"] - A character which is used to specify the tab in the source text. + * @param {string} [newLine="\r\n"] - A character which is used to specify the line break character in the source text. + * @returns {boolean} */ -ApiInterface.prototype.ReplaceTextSmart = function(arrString, sParaTab, sParaNewLine){}; +ApiInterface.prototype.ReplaceTextSmart = function(textStrings, tab, newLine){ return true; }; /** * Creates the empty text properties. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiTextPr} */ -ApiInterface.prototype.CreateTextPr = function () { return new ApiTextPr(); }; +ApiInterface.prototype.CreateTextPr = function(){ return new ApiTextPr(); }; /** * Returns the full name of the currently opened file. * @memberof ApiInterface - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ -ApiInterface.prototype.GetFullName = function () { return ""; }; +ApiInterface.prototype.GetFullName = function(){ return ""; }; /** * Returns the full name of the currently opened file. * @memberof ApiInterface - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiInterface.prototype.FullName = ApiInterface.prototype.GetFullName (); @@ -1854,7 +2354,6 @@ ApiInterface.prototype.FullName = ApiInterface.prototype.GetFullName (); /** * Returns a type of the ApiComment class. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {"comment"} */ ApiComment.prototype.GetClassType = function (){ return ""; }; @@ -1862,7 +2361,6 @@ ApiComment.prototype.GetClassType = function (){ return ""; }; /** * Returns the comment text. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {string} */ ApiComment.prototype.GetText = function () { return ""; }; @@ -1870,7 +2368,6 @@ ApiComment.prototype.GetText = function () { return ""; }; /** * Sets the comment text. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {string} sText - The comment text. * @returns {ApiComment} - this */ @@ -1879,7 +2376,6 @@ ApiComment.prototype.SetText = function (sText) { return new ApiComment(); }; /** * Returns the comment author's name. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {string} */ ApiComment.prototype.GetAuthorName = function () { return ""; }; @@ -1887,16 +2383,21 @@ ApiComment.prototype.GetAuthorName = function () { return ""; }; /** * Sets the comment author's name. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {string} sAuthorName - The comment author's name. * @returns {ApiComment} - this */ ApiComment.prototype.SetAuthorName = function (sAuthorName) { return new ApiComment(); }; +/** + * Returns the user ID of the comment author. + * @memberof ApiComment + * @returns {string} + */ +ApiComment.prototype.GetUserId = function () { return ""; }; + /** * Sets the user ID to the comment author. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {string} sUserId - The user ID of the comment author. * @returns {ApiComment} - this */ @@ -1905,7 +2406,6 @@ ApiComment.prototype.SetUserId = function (sUserId) { return new ApiComment(); } /** * Checks if a comment is solved or not. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {boolean} */ ApiComment.prototype.IsSolved = function () { return true; }; @@ -1913,7 +2413,6 @@ ApiComment.prototype.IsSolved = function () { return true; }; /** * Marks a comment as solved. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {boolean} bSolved - Specifies if a comment is solved or not. * @returns {ApiComment} - this */ @@ -1922,7 +2421,6 @@ ApiComment.prototype.SetSolved = function (bSolved) { return new ApiComment(); } /** * Returns the timestamp of the comment creation in UTC format. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {Number} */ ApiComment.prototype.GetTimeUTC = function () { return 0; }; @@ -1930,7 +2428,6 @@ ApiComment.prototype.GetTimeUTC = function () { return 0; }; /** * Sets the timestamp of the comment creation in UTC format. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {Number | String} nTimeStamp - The timestamp of the comment creation in UTC format. * @returns {ApiComment} - this */ @@ -1939,7 +2436,6 @@ ApiComment.prototype.SetTimeUTC = function (timeStamp) { return new ApiComment() /** * Returns the timestamp of the comment creation in the current time zone format. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {Number} */ ApiComment.prototype.GetTime = function () { return 0; }; @@ -1947,7 +2443,6 @@ ApiComment.prototype.GetTime = function () { return 0; }; /** * Sets the timestamp of the comment creation in the current time zone format. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {Number | String} nTimeStamp - The timestamp of the comment creation in the current time zone format. * @returns {ApiComment} - this */ @@ -1956,7 +2451,6 @@ ApiComment.prototype.SetTime = function (timeStamp) { return new ApiComment(); } /** * Returns the quote text of the current comment. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {Number} */ ApiComment.prototype.GetQuoteText = function () { return 0; }; @@ -1964,7 +2458,6 @@ ApiComment.prototype.GetQuoteText = function () { return 0; }; /** * Returns a number of the comment replies. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {Number} */ ApiComment.prototype.GetRepliesCount = function () { return 0; }; @@ -1972,11 +2465,10 @@ ApiComment.prototype.GetRepliesCount = function () { return 0; }; /** * Adds a reply to a comment. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {String} sText - The comment reply text (required). * @param {String} sAuthorName - The name of the comment reply author (optional). * @param {String} sUserId - The user ID of the comment reply author (optional). - * @param {Number} [nPos=this.GetRepliesCount()] - The comment reply position. + * @param {Number} [nPos=-1] - The comment reply position. If nPos=-1 add to the end. * @returns {ApiComment} - this */ ApiComment.prototype.AddReply = function (sText, sAuthorName, sUserId, nPos) { return new ApiComment(); }; @@ -1984,7 +2476,6 @@ ApiComment.prototype.AddReply = function (sText, sAuthorName, sUserId, nPos) { r /** * Removes the specified comment replies. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @param {Number} [nPos = 0] - The position of the first comment reply to remove. * @param {Number} [nCount = 1] - A number of comment replies to remove. * @param {boolean} [bRemoveAll = false] - Specifies whether to remove all comment replies or not. @@ -1995,15 +2486,30 @@ ApiComment.prototype.RemoveReplies = function (nPos, nCount, bRemoveAll) { retur /** * Deletes the current comment from the document. * @memberof ApiComment - * @typeofeditors ["CDE", "CPE"] * @returns {boolean} */ ApiComment.prototype.Delete = function (){ return true; }; +/** + * Sets the position of the comment in the document. + * + * @memberof ApiComment + * @param {number} x - The X coordinate of the comment position in EMU. + * @param {number} y - The Y coordinate of the comment position in EMU. + */ +ApiComment.prototype.SetPosition = function (x, y) {}; + +/** + * Returns the position of the comment in the document. + * + * @memberof ApiComment + * @returns {Object} - An object with the coordinates (in EMU) of the comment position. + */ +ApiComment.prototype.GetPosition = function () { return new Object(); }; + /** * Returns a type of the ApiCommentReply class. * @memberof ApiCommentReply - * @typeofeditors ["CDE", "CPE"] * @returns {"commentReply"} */ ApiCommentReply.prototype.GetClassType = function () { return ""; }; @@ -2011,7 +2517,6 @@ ApiCommentReply.prototype.GetClassType = function () { return ""; }; /** * Returns the comment reply text. * @memberof ApiCommentReply - * @typeofeditors ["CDE", "CPE"] * @returns {string} */ ApiCommentReply.prototype.GetText = function () { return ""; }; @@ -2019,7 +2524,6 @@ ApiCommentReply.prototype.GetText = function () { return ""; }; /** * Sets the comment reply text. * @memberof ApiCommentReply - * @typeofeditors ["CDE", "CPE"] * @param {string} sText - The comment reply text. * @returns {ApiCommentReply} - this */ @@ -2028,7 +2532,6 @@ ApiCommentReply.prototype.SetText = function (sText) { return new ApiCommentRepl /** * Returns the comment reply author's name. * @memberof ApiCommentReply - * @typeofeditors ["CDE", "CPE"] * @returns {string} */ ApiCommentReply.prototype.GetAuthorName = function () { return ""; }; @@ -2036,7 +2539,6 @@ ApiCommentReply.prototype.GetAuthorName = function () { return ""; }; /** * Sets the comment reply author's name. * @memberof ApiCommentReply - * @typeofeditors ["CDE", "CPE"] * @param {string} sAuthorName - The comment reply author's name. * @returns {ApiCommentReply} - this */ @@ -2045,34 +2547,295 @@ ApiCommentReply.prototype.SetAuthorName = function (sAuthorName) { return new Ap /** * Sets the user ID to the comment reply author. * @memberof ApiCommentReply - * @typeofeditors ["CDE", "CPE"] * @param {string} sUserId - The user ID of the comment reply author. * @returns {ApiCommentReply} - this */ ApiCommentReply.prototype.SetUserId = function (sUserId) { return new ApiCommentReply(); }; /** - * В проверке на лок, которую мы делаем после выполнения скрипта, нужно различать действия сделанные через - * разрешенные методы, и действия, которые пользователь пытался сам сделать с формами - * @param fn - * @param t - * @returns {*} + * Returns a type of the ApiCore class. + * @memberof ApiCore + * @returns {"core"} + * @since 9.0.0 */ -function executeNoFormLockCheck(fn, t){ return null; } +ApiCore.prototype.GetClassType = function () { return ""; }; /** - * Gets a document color object by color name. - * @param {highlightColor} sColor - available highlight color - * @returns {object} + * Sets the document category. + * @memberof ApiCore + * @param {string} sCategory - The document category. + * @since 9.0.0 */ -function private_getHighlightColorByName(sColor){ return null; } +ApiCore.prototype.SetCategory = function (sCategory) {}; /** - * Gets a document highlight name by color object. - * @param {object} oColor - available highlight color - * @returns {highlightColor} + * Returns the document category. + * @memberof ApiCore + * @returns {string} - The document category. + * @since 9.0.0 */ -function private_getHighlightNameByColor(oColor){ return null; } +ApiCore.prototype.GetCategory = function () { return ""; }; + +/** + * Sets the document content status. + * @memberof ApiCore + * @param {string} sStatus - The document content status. + * @since 9.0.0 + */ +ApiCore.prototype.SetContentStatus = function (sStatus) {}; + +/** + * Returns the document content status. + * @memberof ApiCore + * @returns {string} - The document content status. + * @since 9.0.0 + */ +ApiCore.prototype.GetContentStatus = function () { return ""; }; + +/** + * Sets the document creation date. + * @memberof ApiCore + * @param {Date} oCreated - The document creation date. + * @since 9.0.0 + */ +ApiCore.prototype.SetCreated = function (oCreated) {}; + +/** + * Returns the document creation date. + * @memberof ApiCore + * @returns {Date}- The document creation date. + * @since 9.0.0 + */ +ApiCore.prototype.GetCreated = function () { return new Date(); }; + +/** + * Sets the document author. + * @memberof ApiCore + * @param {string} sCreator - The document author. + * @since 9.0.0 + */ +ApiCore.prototype.SetCreator = function (sCreator) {}; + +/** + * Returns the document author. + * @memberof ApiCore + * @returns {string} - The document author. + * @since 9.0.0 + */ +ApiCore.prototype.GetCreator = function () { return ""; }; + +/** + * Sets the document description. + * @memberof ApiCore + * @param {string} sDescription - The document description. + * @since 9.0.0 + */ +ApiCore.prototype.SetDescription = function (sDescription) {}; + +/** + * Returns the document description. + * @memberof ApiCore + * @returns {string} - The document description. + * @since 9.0.0 + */ +ApiCore.prototype.GetDescription = function () { return ""; }; + +/** + * Sets the document identifier. + * @memberof ApiCore + * @param {string} sIdentifier - The document identifier. + * @since 9.0.0 + */ +ApiCore.prototype.SetIdentifier = function (sIdentifier) {}; + +/** + * Returns the document identifier. + * @memberof ApiCore + * @returns {string} - The document identifier. + * @since 9.0.0 + */ +ApiCore.prototype.GetIdentifier = function () { return ""; }; + +/** + * Sets the document keywords. + * @memberof ApiCore + * @param {string} sKeywords - The document keywords in the string format. + * @since 9.0.0 + * + */ +ApiCore.prototype.SetKeywords = function (sKeywords) {}; + +/** + * Returns the document keywords. + * @memberof ApiCore + * @returns {string} - The document keywords in the string format. + * @since 9.0.0 + */ +ApiCore.prototype.GetKeywords = function () { return ""; }; + +/** + * Sets the document language. + * @memberof ApiCore + * @param {string} sLanguage - The document language. + * @since 9.0.0 + */ +ApiCore.prototype.SetLanguage = function (sLanguage) {}; + +/** + * Returns the document language. + * @memberof ApiCore + * @returns {string} - The document language. + * @since 9.0.0 + */ +ApiCore.prototype.GetLanguage = function () { return ""; }; + +/** + * Sets the name of the user who last modified the document. + * @memberof ApiCore + * @param {string} sLastModifiedBy - The name of the user who last modified the document. + * @since 9.0.0 + */ +ApiCore.prototype.SetLastModifiedBy = function (sLastModifiedBy) {}; + +/** + * Returns the name of the user who last modified the document. + * @memberof ApiCore + * @returns {string} - The name of the user who last modified the document. + * @since 9.0.0 + */ +ApiCore.prototype.GetLastModifiedBy = function () { return ""; }; + +/** + * Sets the date when the document was last printed. + * @memberof ApiCore + * @param {Date} oLastPrinted - The date when the document was last printed. + * @since 9.0.0 + */ +ApiCore.prototype.SetLastPrinted = function (oLastPrinted) {}; + +/** + * Returns the date when the document was last printed. + * @memberof ApiCore + * @returns {Date} - The date when the document was last printed. + * @since 9.0.0 + */ +ApiCore.prototype.GetLastPrinted = function () { return new Date(); }; + +/** + * Sets the date when the document was last modified. + * @memberof ApiCore + * @param {Date} oModified - The date when the document was last modified. + * @since 9.0.0 + */ +ApiCore.prototype.SetModified = function (oModified) {}; + +/** + * Returns the date when the document was last modified. + * @memberof ApiCore + * @returns {Date} - The date when the document was last modified. + * @since 9.0.0 + */ +ApiCore.prototype.GetModified = function () { return new Date(); }; + +/** + * Sets the document revision. + * @memberof ApiCore + * @param {string} sRevision - The document revision. + * @since 9.0.0 + */ +ApiCore.prototype.SetRevision = function (sRevision) {}; + +/** + * Returns the document revision. + * @memberof ApiCore + * @returns {string} - The document revision. + * @since 9.0.0 + */ +ApiCore.prototype.GetRevision = function () { return ""; }; + +/** + * Sets the document subject. + * @memberof ApiCore + * @param {string} sSubject - The document subject. + * @since 9.0.0 + */ +ApiCore.prototype.SetSubject = function (sSubject) {}; + +/** + * Returns the document subject. + * @memberof ApiCore + * @returns {string} - The document subject. + * @since 9.0.0 + */ +ApiCore.prototype.GetSubject = function () { return ""; }; + +/** + * Sets the document title. + * @memberof ApiCore + * @param {string} sTitle - The document title. + * @since 9.0.0 + */ +ApiCore.prototype.SetTitle = function (sTitle) {}; + +/** + * Returns the document title. + * @memberof ApiCore + * @returns {string} - The document title. + * @since 9.0.0 + */ +ApiCore.prototype.GetTitle = function () { return ""; }; + +/** + * Sets the document version. + * @memberof ApiCore + * @param {string} sVersion - The document version. + * @since 9.0.0 + */ +ApiCore.prototype.SetVersion = function (sVersion) {}; + +/** + * Returns the document version. + * @memberof ApiCore + * @returns {string} - The document version. + * @since 9.0.0 + */ +ApiCore.prototype.GetVersion = function () { return ""; }; + +/** + * Returns a type of the ApiCustomProperties class. + * @memberof ApiCustomProperties + * @returns {"customProperties"} + * @since 9.0.0 + */ +ApiCustomProperties.prototype.GetClassType = function () { return ""; }; + +/** + * Adds a custom property to the document with automatic type detection. + * @memberof ApiCustomProperties + * @param {string} name - The custom property name. + * @param {string | number | boolean | Date} value - The custom property value. + * @returns {boolean} - Returns false if the type is unsupported. + * @since 9.0.0 + */ +ApiCustomProperties.prototype.Add = function (name, value) { return true; }; + +/** + * Returns the value of a custom property by its name. + * @memberof ApiCustomProperties + * @param {string} name - The custom property name. + * @returns {string | number | Date | boolean | null} - The value of the custom property or null if the property does not exist. + * @since 9.0.0 + */ +ApiCustomProperties.prototype.Get = function (name) { return ""; }; + +/** + * @param oApiRange + * @param oTextPr + * @constructor + */ +function ApiRangeTextPr(oApiRange, oTextPr){} +ApiRangeTextPr.prototype = Object.create(ApiTextPr.prototype); +ApiRangeTextPr.prototype.constructor = ApiRangeTextPr; /** * Class representing a presentation. @@ -2128,6 +2891,12 @@ function ApiThemeFontScheme(ofontScheme){} */ function ApiSlide(oSlide){} +/** + * Class representing a notes page. + * @constructor + */ +function ApiNotesPage(oNotes) {} + /** * Class representing a graphical object. * @constructor @@ -2150,14 +2919,6 @@ function ApiImage(oImage){} ApiImage.prototype = Object.create(ApiDrawing.prototype); ApiImage.prototype.constructor = ApiImage; -/** - * Class representing a chart. - * @constructor - */ -function ApiChart(oChart){} -ApiChart.prototype = Object.create(ApiDrawing.prototype); -ApiChart.prototype.constructor = ApiChart; - /** * Class representing a group of drawings. * @constructor @@ -2178,7 +2939,7 @@ ApiOleObject.prototype.constructor = ApiOleObject; * Class representing a table. * @param oGraphicFrame * @constructor - * */ + */ function ApiTable(oGraphicFrame){} ApiTable.prototype = Object.create(ApiDrawing.prototype); ApiTable.prototype.constructor = ApiTable; @@ -2220,7 +2981,7 @@ function ApiTableCell(oCell){} /** * 60000th of a degree (5400000 = 90 degrees). * @typedef {number} PositiveFixedAngle - * */ + */ /** * A border type. @@ -2255,53 +3016,48 @@ function ApiTableCell(oCell){} /** * A bullet type which will be added to the paragraph in spreadsheet or presentation. * @typedef {("None" | "ArabicPeriod" | "ArabicParenR" | "RomanUcPeriod" | "RomanLcPeriod" | "AlphaLcParenR" | "AlphaLcPeriod" | "AlphaUcParenR" | "AlphaUcPeriod")} BulletType -*/ - -/** - * This type specifies the available chart types which can be used to create a new chart. - * @typedef {("bar" | "barStacked" | "barStackedPercent" | "bar3D" | "barStacked3D" | "barStackedPercent3D" | "barStackedPercent3DPerspective" | "horizontalBar" | "horizontalBarStacked" | "horizontalBarStackedPercent" | "horizontalBar3D" | "horizontalBarStacked3D" | "horizontalBarStackedPercent3D" | "lineNormal" | "lineStacked" | "lineStackedPercent" | "line3D" | "pie" | "pie3D" | "doughnut" | "scatter" | "stock" | "area" | "areaStacked" | "areaStackedPercent")} ChartType */ /** * The available text vertical alignment (used to align text in a shape with a placement for text inside it). * @typedef {("top" | "center" | "bottom")} VerticalTextAlign - * */ + */ /** * The available color scheme identifiers. * @typedef {("accent1" | "accent2" | "accent3" | "accent4" | "accent5" | "accent6" | "bg1" | "bg2" | "dk1" | "dk2" | "lt1" | "lt2" | "tx1" | "tx2")} SchemeColorId - * */ + */ /** * The available preset color names. * @typedef {("aliceBlue" | "antiqueWhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedAlmond" | "blue" | "blueViolet" | "brown" | "burlyWood" | "cadetBlue" | "chartreuse" | "chocolate" | "coral" | "cornflowerBlue" | "cornsilk" | "crimson" | "cyan" | "darkBlue" | "darkCyan" | "darkGoldenrod" | "darkGray" | "darkGreen" | "darkGrey" | "darkKhaki" | "darkMagenta" | "darkOliveGreen" | "darkOrange" | "darkOrchid" | "darkRed" | "darkSalmon" | "darkSeaGreen" | "darkSlateBlue" | "darkSlateGray" | "darkSlateGrey" | "darkTurquoise" | "darkViolet" | "deepPink" | "deepSkyBlue" | "dimGray" | "dimGrey" | "dkBlue" | "dkCyan" | "dkGoldenrod" | "dkGray" | "dkGreen" | "dkGrey" | "dkKhaki" | "dkMagenta" | "dkOliveGreen" | "dkOrange" | "dkOrchid" | "dkRed" | "dkSalmon" | "dkSeaGreen" | "dkSlateBlue" | "dkSlateGray" | "dkSlateGrey" | "dkTurquoise" | "dkViolet" | "dodgerBlue" | "firebrick" | "floralWhite" | "forestGreen" | "fuchsia" | "gainsboro" | "ghostWhite" | "gold" | "goldenrod" | "gray" | "green" | "greenYellow" | "grey" | "honeydew" | "hotPink" | "indianRed" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderBlush" | "lawnGreen" | "lemonChiffon" | "lightBlue" | "lightCoral" | "lightCyan" | "lightGoldenrodYellow" | "lightGray" | "lightGreen" | "lightGrey" | "lightPink" | "lightSalmon" | "lightSeaGreen" | "lightSkyBlue" | "lightSlateGray" | "lightSlateGrey" | "lightSteelBlue" | "lightYellow" | "lime" | "limeGreen" | "linen" | "ltBlue" | "ltCoral" | "ltCyan" | "ltGoldenrodYellow" | "ltGray" | "ltGreen" | "ltGrey" | "ltPink" | "ltSalmon" | "ltSeaGreen" | "ltSkyBlue" | "ltSlateGray" | "ltSlateGrey" | "ltSteelBlue" | "ltYellow" | "magenta" | "maroon" | "medAquamarine" | "medBlue" | "mediumAquamarine" | "mediumBlue" | "mediumOrchid" | "mediumPurple" | "mediumSeaGreen" | "mediumSlateBlue" | "mediumSpringGreen" | "mediumTurquoise" | "mediumVioletRed" | "medOrchid" | "medPurple" | "medSeaGreen" | "medSlateBlue" | "medSpringGreen" | "medTurquoise" | "medVioletRed" | "midnightBlue" | "mintCream" | "mistyRose" | "moccasin" | "navajoWhite" | "navy" | "oldLace" | "olive" | "oliveDrab" | "orange" | "orangeRed" | "orchid" | "paleGoldenrod" | "paleGreen" | "paleTurquoise" | "paleVioletRed" | "papayaWhip" | "peachPuff" | "peru" | "pink" | "plum" | "powderBlue" | "purple" | "red" | "rosyBrown" | "royalBlue" | "saddleBrown" | "salmon" | "sandyBrown" | "seaGreen" | "seaShell" | "sienna" | "silver" | "skyBlue" | "slateBlue" | "slateGray" | "slateGrey" | "snow" | "springGreen" | "steelBlue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whiteSmoke" | "yellow" | "yellowGreen")} PresetColor - * */ + */ /** * Possible values for the position of chart tick labels (either horizontal or vertical). - * * "none" - not display the selected tick labels. - * * "nextTo" - set the position of the selected tick labels next to the main label. - * * "low" - set the position of the selected tick labels in the part of the chart with lower values. - * * "high" - set the position of the selected tick labels in the part of the chart with higher values. + * "none" - not display the selected tick labels. + * "nextTo" - set the position of the selected tick labels next to the main label. + * "low" - set the position of the selected tick labels in the part of the chart with lower values. + * "high" - set the position of the selected tick labels in the part of the chart with higher values. * @typedef {("none" | "nextTo" | "low" | "high")} TickLabelPosition - * **/ + */ /** * The type of a fill which uses an image as a background. - * * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. - * * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. + * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. + * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. * @typedef {"tile" | "stretch"} BlipFillType - * */ + */ /** * The available preset patterns which can be used for the fill. * @typedef {"cross" | "dashDnDiag" | "dashHorz" | "dashUpDiag" | "dashVert" | "diagBrick" | "diagCross" | "divot" | "dkDnDiag" | "dkHorz" | "dkUpDiag" | "dkVert" | "dnDiag" | "dotDmnd" | "dotGrid" | "horz" | "horzBrick" | "lgCheck" | "lgConfetti" | "lgGrid" | "ltDnDiag" | "ltHorz" | "ltUpDiag" | "ltVert" | "narHorz" | "narVert" | "openDmnd" | "pct10" | "pct20" | "pct25" | "pct30" | "pct40" | "pct5" | "pct50" | "pct60" | "pct70" | "pct75" | "pct80" | "pct90" | "plaid" | "shingle" | "smCheck" | "smConfetti" | "smGrid" | "solidDmnd" | "sphere" | "trellis" | "upDiag" | "vert" | "wave" | "wdDnDiag" | "wdUpDiag" | "weave" | "zigZag"} PatternType - * */ + */ /** * The available types of tick mark appearance. * @typedef {("cross" | "in" | "none" | "out")} TickMark - * */ + */ /** * Text transform type. @@ -2311,7 +3067,7 @@ function ApiTableCell(oCell){} * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform - * */ + */ /** * Axis position in the chart. @@ -2322,18 +3078,47 @@ function ApiTableCell(oCell){} * Standard numeric format. * @typedef {("General" | "0" | "0.00" | "#,##0" | "#,##0.00" | "0%" | "0.00%" | * "0.00E+00" | "# ?/?" | "# ??/??" | "m/d/yyyy" | "d-mmm-yy" | "d-mmm" | "mmm-yy" | "h:mm AM/PM" | - * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_);(#,##0)" | "#,##0_);[Red](#,##0)" | - * "#,##0.00_);(#,##0.00)" | "#,##0.00_);[Red](#,##0.00)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_\);(#,##0)" | "#,##0_\);\[Red\]\(#,##0)" | + * "#,##0.00_\);\(#,##0.00\)" | "#,##0.00_\);\[Red\]\(#,##0.00\)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + */ + +/** + * @typedef {("body" | "chart" | "clipArt" | "ctrTitle" | "diagram" | "date" | "footer" | "header" | "media" | "object" | "picture" | "sldImage" | "sldNumber" | "subTitle" | "table" | "title")} PlaceholderType - Available placeholder types. + */ + +/** + * Any valid drawing element. + * @typedef {(ApiShape | ApiImage | ApiGroup | ApiOleObject | ApiTable | ApiChart )} Drawing + */ + +/** + * Available drawing element for grouping. + * @typedef {(ApiShape | ApiGroup | ApiImage | ApiChart)} DrawingForGroup + */ + +/** + * Any valid element which can be added to the document structure. + * @typedef {(ApiParagraph)} DocumentElement + */ + +/** + * The types of elements that can be added to the paragraph structure. + * @typedef {(ApiUnsupported | ApiRun | ApiHyperlink)} ParagraphContent */ /** * The 1000th of a percent (100000 = 100%). * @typedef {number} PositivePercentage - * */ + */ + +/** + * Represents the type of objects in a selection. + * @typedef {("none" | "shapes" | "slides" | "text")} SelectionType - Available selection types. + * + */ /** * Returns the main presentation. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @returns {ApiPresentation} */ @@ -2341,7 +3126,6 @@ ApiInterface.prototype.GetPresentation = function(){ return new ApiPresentation( /** * Creates a new slide master. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @param {ApiTheme} [oTheme = ApiPresentation.GetMaster(0).GetTheme()] - The presentation theme object. * @returns {ApiMaster} - returns null if presentation theme doesn't exist. @@ -2350,7 +3134,6 @@ ApiInterface.prototype.CreateMaster = function(oTheme){ return new ApiMaster(); /** * Creates a new slide layout and adds it to the slide master if it is specified. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @param {ApiMaster} [oMaster = null] - Parent slide master. * @returns {ApiLayout} @@ -2359,7 +3142,6 @@ ApiInterface.prototype.CreateLayout = function(oMaster){ return new ApiLayout(); /** * Creates a new placeholder. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @param {string} sType - The placeholder type ("body", "chart", "clipArt", "ctrTitle", "diagram", "date", "footer", "header", "media", "object", "picture", "sldImage", "sldNumber", "subTitle", "table", "title"). * @returns {ApiPlaceholder} @@ -2368,7 +3150,6 @@ ApiInterface.prototype.CreatePlaceholder = function(sType){ return new ApiPlaceh /** * Creates a new presentation theme. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @param {string} sName - Theme name. * @param {ApiMaster} oMaster - Slide master. Required parameter. @@ -2381,7 +3162,6 @@ ApiInterface.prototype.CreateTheme = function(sName, oMaster, oClrScheme, oForma /** * Creates a new theme color scheme. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @param {(ApiUniColor[] | ApiRGBColor[])} arrColors - Set of colors which are referred to as a color scheme. * The color scheme is responsible for defining a list of twelve colors. @@ -2393,7 +3173,6 @@ ApiInterface.prototype.CreateThemeColorScheme = function(arrColors, sName){ retu /** * Creates a new theme format scheme. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @param {ApiFill[]} arrFill - This array contains the fill styles. It should be consist of subtle, moderate and intense fills. * @param {ApiFill[]} arrBgFill - This array contains the background fill styles. It should be consist of subtle, moderate and intense fills. @@ -2405,7 +3184,6 @@ ApiInterface.prototype.CreateThemeFormatScheme = function(arrFill, arrBgFill, ar /** * Creates a new theme font scheme. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @param {string} mjLatin - The major theme font applied to the latin text. * @param {string} mjEa - The major theme font applied to the east asian text. @@ -2420,7 +3198,6 @@ ApiInterface.prototype.CreateThemeFontScheme = function(mjLatin, mjEa, mjCs, mnL /** * Creates a new slide. - * @typeofeditors ["CPE"] * @memberof ApiInterface * @returns {ApiSlide} */ @@ -2429,7 +3206,6 @@ ApiInterface.prototype.CreateSlide = function(){ return new ApiSlide(); }; /** * Creates an image with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CPE"] * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, * only internet URL or Base64 encoded images are supported). * @param {EMU} nWidth - The image width in English measure units. @@ -2441,7 +3217,6 @@ ApiInterface.prototype.CreateImage = function(sImageSrc, nWidth, nHeight){ retur /** * Creates an OLE object with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CPE"] * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). * @param {EMU} nWidth - The OLE object width in English measure units. * @param {EMU} nHeight - The OLE object height in English measure units. @@ -2454,43 +3229,43 @@ ApiInterface.prototype.CreateOleObject = function(sImageSrc, nWidth, nHeight, sD /** * Creates a shape with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CPE"] * @param {ShapeType} [sType="rect"] - The shape type which specifies the preset shape geometry. * @param {EMU} [nWidth = 914400] - The shape width in English measure units. * @param {EMU} [nHeight = 914400] - The shape height in English measure units. * @param {ApiFill} [oFill = Api.CreateNoFill()] - The color or pattern used to fill the shape. * @param {ApiStroke} [oStroke = Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the element shadow. * @returns {ApiShape} - * */ + */ ApiInterface.prototype.CreateShape = function(sType, nWidth, nHeight, oFill, oStroke){ return new ApiShape(); }; /** * Creates a chart with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CPE"] * @param {ChartType} [sType="bar"] - The chart type used for the chart display. - * @param {Array} aSeries - The array of the data used to build the chart from. - * @param {Array} aSeriesNames - The array of the names (the source table column names) used for the data which the chart will be build from. - * @param {Array} aCatNames - The array of the names (the source table row names) used for the data which the chart will be build from. + * @param {number[][]} aSeries - The array of the data used to build the chart from. + * @param {number[] | string[]} aSeriesNames - The array of the names (the source table column names) used for the data which the chart will be build from. + * @param {number[] | string[]} aCatNames - The array of the names (the source table row names) used for the data which the chart will be build from. * @param {EMU} nWidth - The chart width in English measure units. * @param {EMU} nHeight - The chart height in English measure units. * @param {number} nStyleIndex - The chart color style index (can be 1 - 48, as described in OOXML specification). * @param {NumFormat[] | String[]} aNumFormats - Numeric formats which will be applied to the series (can be custom formats). * The default numeric format is "General". * @returns {ApiChart} - * */ + */ ApiInterface.prototype.CreateChart = function(sType, aSeries, aSeriesNames, aCatNames, nWidth, nHeight, nStyleIndex, aNumFormats){ return new ApiChart(); }; /** * Creates a group of drawings. * @memberof ApiInterface - * @param {Array} aDrawings - The array of drawings. + * @param {DrawingForGroup[]} aDrawings - An array of drawings to group. * @returns {ApiGroup} - * */ -ApiInterface.prototype.CreateGroup = function(aDrawings){ return new ApiGroup(); }; + * @since 8.3.0 + */ +ApiInterface.prototype.CreateGroup = function(aDrawings) { return new ApiGroup(); }; /** * Creates a table. + * @memberof ApiInterface * @param nCols - Number of columns. * @param nRows - Number of rows. * @returns {ApiTable} @@ -2500,14 +3275,12 @@ ApiInterface.prototype.CreateTable = function(nCols, nRows){ return new ApiTable /** * Creates a new paragraph. * @memberof ApiInterface - * @typeofeditors ["CPE"] * @returns {ApiParagraph} */ ApiInterface.prototype.CreateParagraph = function(){ return new ApiParagraph(); }; /** * Saves changes to the specified document. - * @typeofeditors ["CPE"] * @memberof ApiInterface */ ApiInterface.prototype.Save = function () {}; @@ -2515,7 +3288,6 @@ ApiInterface.prototype.Save = function () {}; /** * Creates a Text Art object with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CPE"] * @param {ApiTextPr} [oTextPr=Api.CreateTextPr()] - The text properties. * @param {string} [sText="Your text here"] - The text for the Text Art object. * @param {TextTransform} [sTransform="textNoShape"] - Text transform type. @@ -2534,15 +3306,21 @@ ApiInterface.prototype.CreateWordArt = function(oTextPr, sText, sTransform, oFil * Converts the specified JSON object into the Document Builder object of the corresponding type. * @memberof ApiInterface * @param {JSON} sMessage - The JSON object to convert. - * @typeofeditors ["CPE"] */ ApiInterface.prototype.FromJSON = function(sMessage){}; +/** + * Returns the selection from the current presentation. + * @memberof ApiInterface + * @returns {ApiSelection} + * @since 8.3.0 + */ +ApiInterface.prototype.GetSelection = function(){ return new ApiSelection(); }; + /** * Subscribes to the specified event and calls the callback function when the event fires. * @function * @memberof ApiInterface - * @typeofeditors ["CPE"] * @param {string} eventName - The event name. * @param {function} callback - Function to be called when the event fires. */ @@ -2552,21 +3330,18 @@ ApiInterface.prototype["attachEvent"] = ApiInterface.prototype.attachEvent;{}; * Unsubscribes from the specified event. * @function * @memberof ApiInterface - * @typeofeditors ["CPE"] * @param {string} eventName - The event name. */ ApiInterface.prototype["detachEvent"] = ApiInterface.prototype.detachEvent;{}; /** * Returns a type of the ApiPresentation class. - * @typeofeditors ["CPE"] * @returns {"presentation"} */ ApiPresentation.prototype.GetClassType = function(){ return ""; }; /** * Returns the index for the current slide. - * @typeofeditors ["CPE"] * @memberof ApiPresentation * @returns {number} */ @@ -2582,15 +3357,21 @@ ApiPresentation.prototype.GetSlideByIndex = function(nIndex){ return new ApiSlid /** * Returns the current slide. - * @typeofeditors ["CPE"] * @memberof ApiPresentation * @returns {ApiSlide} */ ApiPresentation.prototype.GetCurrentSlide = function () { return new ApiSlide(); }; +/** + * Returns the current visible slide. + * @memberof ApiPresentation + * @returns {ApiSlide | null} - Returns null if the current slide is not found or not visible. + * @since 9.0.0 + */ +ApiPresentation.prototype.GetCurrentVisibleSlide = function () { return new ApiSlide(); }; + /** * Appends a new slide to the end of the presentation. - * @typeofeditors ["CPE"] * @memberof ApiPresentation * @param {ApiSlide} oSlide - The slide created using the {@link Api#CreateSlide} method. */ @@ -2598,7 +3379,6 @@ ApiPresentation.prototype.AddSlide = function(oSlide) {}; /** * Sets the size to the current presentation. - * @typeofeditors ["CPE"] * @memberof ApiPresentation * @param {EMU} nWidth - The presentation width in English measure units. * @param {EMU} nHeight - The presentation height in English measure units. @@ -2607,14 +3387,12 @@ ApiPresentation.prototype.SetSizes = function(nWidth, nHeight) {}; /** * Creates a new history point. - * @typeofeditors ["CPE"] * @memberof ApiPresentation */ ApiPresentation.prototype.CreateNewHistoryPoint = function(){}; /** * Replaces the current image with an image specified. - * @typeofeditors ["CPE"] * @memberof ApiPresentation * @param {string} sImageUrl - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). * @param {EMU} Width - The image width in English measure units. @@ -2625,7 +3403,6 @@ ApiPresentation.prototype.ReplaceCurrentImage = function(sImageUrl, Width, Heigh /** * Specifies the languages which will be used to check spelling and grammar (if requested). * @memberof ApiPresentation - * @typeofeditors ["CPE"] * @param {string} sLangId - The possible value for this parameter is a language identifier as defined by * RFC 4646/BCP 47. Example: "en-CA". * @returns {boolean} @@ -2634,21 +3411,32 @@ ApiPresentation.prototype.SetLanguage = function(sLangId){ return true; }; /** * Returns a number of slides. - * @typeofeditors ["CPE"] * @returns {number} */ ApiPresentation.prototype.GetSlidesCount = function(){ return 0; }; +/** + * Returns an array of all slides from the current presentation. + * @returns {ApiSlide[]} + * @since 8.3.0 + */ +ApiPresentation.prototype.GetAllSlides = function(){ return [new ApiSlide()]; }; + /** * Returns a number of slide masters. - * @typeofeditors ["CPE"] * @returns {number} */ ApiPresentation.prototype.GetMastersCount = function(){ return 0; }; +/** + * Returns an array of all slide masters from the current presentation. + * @returns {ApiMaster[]} + * @since 8.3.0 + */ +ApiPresentation.prototype.GetAllSlideMasters = function(){ return [new ApiMaster()]; }; + /** * Returns a slide master by its position in the presentation. - * @typeofeditors ["CPE"] * @param {number} nPos - Slide master position in the presentation * @returns {ApiMaster | null} - returns null if position is invalid. */ @@ -2656,7 +3444,6 @@ ApiPresentation.prototype.GetMaster = function(nPos){ return new ApiMaster(); }; /** * Adds the slide master to the presentation slide masters collection. - * @typeofeditors ["CPE"] * @param {number} [nPos = ApiPresentation.GetMastersCount()] * @param {ApiMaster} oApiMaster - The slide master to be added. * @returns {boolean} - return false if position is invalid or oApiMaster doesn't exist. @@ -2665,10 +3452,9 @@ ApiPresentation.prototype.AddMaster = function(nPos, oApiMaster){ return true; } /** * Applies a theme to all the slides in the presentation. - * @typeofeditors ["CPE"] * @param {ApiTheme} oApiTheme - The presentation theme. * @returns {boolean} - returns false if param isn't theme or presentation doesn't exist. - * */ + */ ApiPresentation.prototype.ApplyTheme = function(oApiTheme){ return true; }; /** @@ -2677,14 +3463,12 @@ ApiPresentation.prototype.ApplyTheme = function(oApiTheme){ return true; }; * @memberof ApiPresentation * @param {Number} [nStart=0] - The starting position for the deletion range. * @param {Number} [nCount=ApiPresentation.GetSlidesCount()] - The number of slides to delete. - * @typeofeditors ["CPE"] * @returns {boolean} */ ApiPresentation.prototype.RemoveSlides = function(nStart, nCount){ return true; }; /** * Returns the presentation width in English measure units. - * @typeofeditors ["CPE"] * @memberof ApiPresentation * @returns {EMU} */ @@ -2692,7 +3476,6 @@ ApiPresentation.prototype.GetWidth = function() { return new EMU(); }; /** * Returns the presentation height in English measure units. - * @typeofeditors ["CPE"] * @memberof ApiPresentation * @returns {EMU} */ @@ -2701,8 +3484,7 @@ ApiPresentation.prototype.GetHeight = function() { return new EMU(); }; /** * Converts the ApiPresentation object into the JSON object. * @memberof ApiPresentation - * @typeofeditors ["CPE"] - * @param {bool} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). + * @param {boolean} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). * @returns {JSON} */ ApiPresentation.prototype.ToJSON = function(bWriteTableStyles){ return new JSON(); }; @@ -2710,13 +3492,12 @@ ApiPresentation.prototype.ToJSON = function(bWriteTableStyles){ return new JSON( /** * Converts the slides from the current ApiPresentation object into the JSON objects. * @memberof ApiPresentation - * @typeofeditors ["CPE"] - * @param {bool} [nStart=0] - The index to the start slide. - * @param {bool} [nStart=ApiPresentation.GetSlidesCount() - 1] - The index to the end slide. - * @param {bool} [bWriteLayout=false] - Specifies if the slide layout will be written to the JSON object or not. - * @param {bool} [bWriteMaster=false] - Specifies if the slide master will be written to the JSON object or not (bWriteMaster is false if bWriteLayout === false). - * @param {bool} [bWriteAllMasLayouts=false] - Specifies if all child layouts from the slide master will be written to the JSON object or not. - * @param {bool} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). + * @param {boolean} [nStart=0] - The index to the start slide. + * @param {boolean} [nStart=ApiPresentation.GetSlidesCount() - 1] - The index to the end slide. + * @param {boolean} [bWriteLayout=false] - Specifies if the slide layout will be written to the JSON object or not. + * @param {boolean} [bWriteMaster=false] - Specifies if the slide master will be written to the JSON object or not (bWriteMaster is false if bWriteLayout === false). + * @param {boolean} [bWriteAllMasLayouts=false] - Specifies if all child layouts from the slide master will be written to the JSON object or not. + * @param {boolean} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). * @returns {JSON[]} */ ApiPresentation.prototype.SlidesToJSON = function(nStart, nEnd, bWriteLayout, bWriteMaster, bWriteAllMasLayouts, bWriteTableStyles){ return [new JSON()]; }; @@ -2724,21 +3505,116 @@ ApiPresentation.prototype.SlidesToJSON = function(nStart, nEnd, bWriteLayout, bW /** * Returns all comments from the current presentation. * @memberof ApiPresentation - * @typeofeditors ["CPE"] * @returns {ApiComment[]} */ ApiPresentation.prototype.GetAllComments = function(){ return [new ApiComment()]; }; +/** + * Private method to collect all objects of a specific type from the presentation (OleObjects, Charts, Shapes, Images). + * Calls 'getObjectsMethod' method on each slide, master and layout to get the objects. + */ +ApiPresentation.prototype._collectAllObjects = function (getObjectsMethod) {}; + +/** + * Returns an array with all the OLE objects from the current presentation. + * @memberof ApiPresentation + * @returns {ApiOleObject[]} + * @since 9.0.0 + */ +ApiPresentation.prototype.GetAllOleObjects = function () { return [new ApiOleObject()]; }; + +/** + * Returns an array with all the chart objects from the current presentation. + * @memberof ApiPresentation + * @returns {ApiChart[]} + * @since 9.0.0 + */ +ApiPresentation.prototype.GetAllCharts = function () { return [new ApiChart()]; }; + +/** + * Returns an array with all the shape objects from the current presentation. + * @memberof ApiPresentation + * @returns {ApiShape[]} + * @since 9.0.0 + */ +ApiPresentation.prototype.GetAllShapes = function () { return [new ApiShape()]; }; + +/** + * Returns an array with all the image objects from the current presentation. + * @memberof ApiPresentation + * @returns {ApiImage[]} + * @since 9.0.0 + */ +ApiPresentation.prototype.GetAllImages = function () { return [new ApiImage()]; }; + +/** + * Returns an array with all the drawing objects from the current presentation. + * @memberof ApiPresentation + * @returns {Drawing[]} + * @since 9.0.0 + */ +ApiPresentation.prototype.GetAllDrawings = function () { return [new Drawing()]; }; + +/** + * Returns the document information: + * Application - the application the document has been created with. + * CreatedRaw - the date and time when the file was created. + * Created - the parsed date and time when the file was created. + * LastModifiedRaw - the date and time when the file was last modified. + * LastModified - the parsed date and time when the file was last modified. + * LastModifiedBy - the name of the user who has made the latest change to the document. + * Authors - the persons who has created the file. + * Title - this property allows you to simplify your documents classification. + * Tags - this property allows you to simplify your documents classification. + * Subject - this property allows you to simplify your documents classification. + * Comment - this property allows you to simplify your documents classification. + * @memberof ApiPresentation + * @returns {object} + */ +ApiPresentation.prototype.GetDocumentInfo = function(){ return new object(); }; + +/** + * Returns the core properties interface for the current presentation. + * This method is used to view or modify standard metadata such as title, author, and keywords. + * @memberof ApiPresentation + * @returns {ApiCore} + * @since 9.0.0 + */ +ApiPresentation.prototype.GetCore = function () { return new ApiCore(); }; + +/** + * Returns the custom properties from the current presentation. + * @memberof ApiPresentation + * @returns {ApiCustomProperties} + * @since 9.0.0 + */ +ApiPresentation.prototype.GetCustomProperties = function () { return new ApiCustomProperties(); }; + +/** +* Adds a math equation to the current presentation. +* @memberof ApiPresentation +* @param {string} sText - The math equation text. +* @param {string} sFormat - The math equation format. Possible values are "unicode" and "latex". +* @returns {boolean} +* @since 9.0.0 +*/ +ApiPresentation.prototype.AddMathEquation = function (sText, sFormat) { return true; }; + /** * Returns the type of the ApiMaster class. - * @typeofeditors ["CPE"] * @returns {"master"} */ ApiMaster.prototype.GetClassType = function(){ return ""; }; +/** + * Returns all layouts from the slide master. + * @returns {ApiLayout[]} - Returns an empty array if the slide master doesn't have layouts. + * @since 9.0.0 + */ +ApiMaster.prototype.GetAllLayouts = function () { return [new ApiLayout()]; }; + /** * Returns a layout of the specified slide master by its position. - * @typeofeditors ["CPE"] * @param {number} nPos - Layout position. * @returns {ApiLayout | null} - returns null if position is invalid. */ @@ -2746,7 +3622,6 @@ ApiMaster.prototype.GetLayout = function(nPos){ return new ApiLayout(); }; /** * Adds a layout to the specified slide master. - * @typeofeditors ["CPE"] * @param {number} [nPos = ApiMaster.GetLayoutsCount()] - Position where a layout will be added. * @param {ApiLayout} oLayout - A layout to be added. * @returns {boolean} - returns false if oLayout isn't a layout. @@ -2755,7 +3630,6 @@ ApiMaster.prototype.AddLayout = function(nPos, oLayout){ return true; }; /** * Removes the layouts from the current slide master. - * @typeofeditors ["CPE"] * @param {number} nPos - Position from which a layout will be deleted. * @param {number} [nCount = 1] - Number of layouts to delete. * @returns {boolean} - return false if position is invalid. @@ -2764,14 +3638,12 @@ ApiMaster.prototype.RemoveLayout = function(nPos, nCount){ return true; }; /** * Returns a number of layout objects. - * @typeofeditors ["CPE"] * @returns {number} */ ApiMaster.prototype.GetLayoutsCount = function(){ return 0; }; /** * Adds an object (image, shape or chart) to the current slide master. - * @typeofeditors ["CPE"] * @memberof ApiMaster * @param {ApiDrawing} oDrawing - The object which will be added to the current slide master. * @returns {boolean} - returns false if slide master doesn't exist. @@ -2780,7 +3652,6 @@ ApiMaster.prototype.AddObject = function(oDrawing){ return true; }; /** * Removes objects (image, shape or chart) from the current slide master. - * @typeofeditors ["CPE"] * @memberof ApiMaster * @param {number} nPos - Position from which the object will be deleted. * @param {number} [nCount = 1] - Number of objects to delete. @@ -2791,121 +3662,130 @@ ApiMaster.prototype.RemoveObject = function(nPos, nCount){ return true; }; /** * Sets the background to the current slide master. * @memberOf ApiMaster - * @typeofeditors ["CPE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the presentation slide master background. * @returns {boolean} - * */ + */ ApiMaster.prototype.SetBackground = function(oApiFill){ return true; }; /** * Clears the slide master background. - * @typeofeditors ["CPE"] * @returns {boolean} - return false if slide master doesn't exist. - * */ + */ ApiMaster.prototype.ClearBackground = function(){ return true; }; /** * Creates a copy of the specified slide master object. - * @typeofeditors ["CPE"] * @returns {ApiMaster | null} - returns new ApiMaster object that represents the copy of slide master. * Returns null if slide doesn't exist. - * */ + */ ApiMaster.prototype.Copy = function(){ return new ApiMaster(); }; /** * Creates a duplicate of the specified slide master object, adds the new slide master to the slide masters collection. - * @typeofeditors ["CPE"] * @param {number} [nPos = ApiPresentation.GetMastersCount()] - Position where the new slide master will be added. * @returns {ApiMaster | null} - returns new ApiMaster object that represents the copy of slide master. * Returns null if slide master doesn't exist or is not in the presentation. - * */ + */ ApiMaster.prototype.Duplicate = function(nPos){ return new ApiMaster(); }; /** * Deletes the specified object from the parent if it exists. - * @typeofeditors ["CPE"] * @returns {boolean} - return false if master doesn't exist or is not in the presentation. - * */ + */ ApiMaster.prototype.Delete = function(){ return true; }; /** * Returns a theme of the slide master. - * @typeofeditors ["CPE"] * @returns {ApiTheme | null} - returns null if theme doesn't exist. - * */ + */ ApiMaster.prototype.GetTheme = function(){ return new ApiTheme(); }; /** * Sets a theme to the slide master. * Sets a copy of the theme object. - * @typeofeditors ["CPE"] * @param {ApiTheme} oTheme - Presentation theme. * @returns {boolean} - return false if oTheme isn't a theme or slide master doesn't exist. - * */ + */ ApiMaster.prototype.SetTheme = function(oTheme){ return true; }; /** * Returns an array with all the drawing objects from the slide master. - * @typeofeditors ["CPE"] - * @returns {ApiDrawing[]} - * */ -ApiMaster.prototype.GetAllDrawings = function(){ return [new ApiDrawing()]; }; + * @returns {Drawing[]} + */ +ApiMaster.prototype.GetAllDrawings = function(){ return [new Drawing()]; }; /** * Returns an array with all the shape objects from the slide master. - * @typeofeditors ["CPE"] * @returns {ApiShape[]} - * */ + */ ApiMaster.prototype.GetAllShapes = function(){ return [new ApiShape()]; }; /** * Returns an array with all the image objects from the slide master. - * @typeofeditors ["CPE"] * @returns {ApiImage[]} - * */ + */ ApiMaster.prototype.GetAllImages = function(){ return [new ApiImage()]; }; /** * Returns an array with all the chart objects from the slide master. - * @typeofeditors ["CPE"] * @returns {ApiChart[]} - * */ -ApiMaster.prototype.GetAllCharts = function(){ return [new ApiChart()]; }; + */ +ApiMaster.prototype.GetAllCharts = function() { return [new ApiChart()]; }; /** * Returns an array with all the OLE objects from the slide master. - * @typeofeditors ["CPE"] * @returns {ApiOleObject[]} - * */ -ApiMaster.prototype.GetAllOleObjects = function(){ return [new ApiOleObject()]; }; + */ +ApiMaster.prototype.GetAllOleObjects = function() { return [new ApiOleObject()]; }; /** * Converts the ApiMaster object into the JSON object. * @memberof ApiMaster - * @typeofeditors ["CPE"] - * @param {bool} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). + * @param {boolean} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). * @returns {JSON} */ ApiMaster.prototype.ToJSON = function(bWriteTableStyles){ return new JSON(); }; +/** + * Returns an array of drawings by the specified placeholder type. + * @memberof ApiMaster + * @param {PlaceholderType} sType - The placeholder type. + * @returns {Drawing[]} + * @since 8.2.0 + */ +ApiMaster.prototype.GetDrawingsByPlaceholderType = function(sType) { return [new Drawing()]; }; + +/** + * Groups an array of drawings in the current slide master. + * @memberof ApiMaster + * @param {DrawingForGroup[]} aDrawings - An array of drawings to group. + * @returns {ApiGroup} + * @since 8.3.0 + */ +ApiMaster.prototype.GroupDrawings = function(aDrawings){ return new ApiGroup(); }; + /** * Returns the type of the ApiLayout class. - * @typeofeditors ["CPE"] * @returns {"layout"} */ ApiLayout.prototype.GetClassType = function(){ return ""; }; /** * Sets a name to the current layout. - * @typeofeditors ["CPE"] * @param {string} sName - Layout name to be set. * @returns {boolean} */ ApiLayout.prototype.SetName = function(sName){ return true; }; +/** + * Returns a name of the current layout. + * @returns {string} + * @since 8.3.0 + */ +ApiLayout.prototype.GetName = function(){ return ""; }; + /** * Adds an object (image, shape or chart) to the current slide layout. - * @typeofeditors ["CPE"] * @memberof ApiLayout * @param {ApiDrawing} oDrawing - The object which will be added to the current slide layout. * @returns {boolean} - returns false if slide layout doesn't exist. @@ -2914,7 +3794,6 @@ ApiLayout.prototype.AddObject = function(oDrawing){ return true; }; /** * Removes objects (image, shape or chart) from the current slide layout. - * @typeofeditors ["CPE"] * @memberof ApiLayout * @param {number} nPos - Position from which the object will be deleted. * @param {number} [nCount = 1] - The number of elements to delete. @@ -2925,143 +3804,178 @@ ApiLayout.prototype.RemoveObject = function(nPos, nCount){ return true; }; /** * Sets the background to the current slide layout. * @memberOf ApiLayout - * @typeofeditors ["CPE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the presentation slide layout background.\ * @returns {boolean} - * */ + */ ApiLayout.prototype.SetBackground = function(oApiFill){ return true; }; /** * Clears the slide layout background. - * @typeofeditors ["CPE"] * @returns {boolean} - return false if slide layout doesn't exist. - * */ + */ ApiLayout.prototype.ClearBackground = function(){ return true; }; /** * Sets the master background as the background of the layout. - * @typeofeditors ["CPE"] * @returns {boolean} - returns false if master is null or master hasn't background. - * */ + */ ApiLayout.prototype.FollowMasterBackground = function(){ return true; }; /** * Creates a copy of the specified slide layout object. * Copies without master slide. - * @typeofeditors ["CPE"] * @returns {ApiLayout | null} - returns new ApiLayout object that represents the copy of slide layout. * Returns null if slide layout doesn't exist. - * */ + */ ApiLayout.prototype.Copy = function(){ return new ApiLayout(); }; /** * Deletes the specified object from the parent slide master if it exists. - * @typeofeditors ["CPE"] * @returns {boolean} - return false if parent slide master doesn't exist. - * */ + */ ApiLayout.prototype.Delete = function(){ return true; }; /** * Creates a duplicate of the specified slide layout object, adds the new slide layout to the slide layout collection. - * @typeofeditors ["CPE"] * @param {number} [nPos = ApiMaster.GetLayoutsCount()] - Position where the new slide layout will be added. * @returns {ApiLayout | null} - returns new ApiLayout object that represents the copy of slide layout. * Returns null if slide layout doesn't exist or is not in the slide master. - * */ + */ ApiLayout.prototype.Duplicate = function(nPos){ return new ApiLayout(); }; /** * Moves the specified layout to a specific location within the same collection. - * @typeofeditors ["CPE"] * @param {number} nPos - Position where the specified slide layout will be moved to. * @returns {boolean} - returns false if layout or parent slide master doesn't exist or position is invalid. - * */ + */ ApiLayout.prototype.MoveTo = function(nPos){ return true; }; /** * Returns an array with all the drawing objects from the slide layout. - * @typeofeditors ["CPE"] - * @returns {ApiDrawing[]} - * */ -ApiLayout.prototype.GetAllDrawings = function(){ return [new ApiDrawing()]; }; + * @returns {Drawing[]} + */ +ApiLayout.prototype.GetAllDrawings = function(){ return [new Drawing()]; }; /** * Returns an array with all the shape objects from the slide layout. - * @typeofeditors ["CPE"] * @returns {ApiShape[]} - * */ + */ ApiLayout.prototype.GetAllShapes = function(){ return [new ApiShape()]; }; /** * Returns an array with all the image objects from the slide layout. - * @typeofeditors ["CPE"] * @returns {ApiImage[]} - * */ + */ ApiLayout.prototype.GetAllImages = function(){ return [new ApiImage()]; }; /** * Returns an array with all the chart objects from the slide layout. - * @typeofeditors ["CPE"] * @returns {ApiChart[]} - * */ -ApiLayout.prototype.GetAllCharts = function(){ return [new ApiChart()]; }; + */ +ApiLayout.prototype.GetAllCharts = function() { return [new ApiChart()]; }; /** * Returns an array with all the OLE objects from the slide layout. - * @typeofeditors ["CPE"] * @returns {ApiOleObject[]} - * */ + */ ApiLayout.prototype.GetAllOleObjects = function(){ return [new ApiOleObject()]; }; /** * Returns the parent slide master of the current layout. - * @typeofeditors ["CPE"] * @returns {ApiMaster} - returns null if parent slide master doesn't exist. - * */ + */ ApiLayout.prototype.GetMaster = function(){ return new ApiMaster(); }; /** * Converts the ApiLayout object into the JSON object. * @memberof ApiLayout - * @typeofeditors ["CPE"] - * @param {bool} [bWriteMaster=false] - Specifies if the slide master will be written to the JSON object or not. - * @param {bool} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). + * @param {boolean} [bWriteMaster=false] - Specifies if the slide master will be written to the JSON object or not. + * @param {boolean} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). * @returns {JSON} */ ApiLayout.prototype.ToJSON = function(bWriteMaster, bWriteTableStyles){ return new JSON(); }; +/** + * Returns an array of drawings by the specified placeholder type. + * @memberof ApiLayout + * @param {PlaceholderType} sType - The placeholder type. + * @returns {Drawing[]} + * @since 8.2.0 + */ +ApiLayout.prototype.GetDrawingsByPlaceholderType = function(sType) { return [new Drawing()]; }; + +/** + * Groups an array of drawings in the current layout. + * @memberof ApiLayout + * @param {DrawingForGroup[]} aDrawings - An array of drawings to group. + * @returns {ApiGroup} + * @since 8.3.0 + */ +ApiLayout.prototype.GroupDrawings = function(aDrawings){ return new ApiGroup(); }; + /** * Returns the type of the ApiPlaceholder class. - * @typeofeditors ["CPE"] * @returns {"placeholder"} */ ApiPlaceholder.prototype.GetClassType = function(){ return ""; }; /** * Sets the placeholder type. - * @typeofeditors ["CPE"] - * @param {string} sType - Placeholder type ("body", "chart", "clipArt", "ctrTitle", "diagram", "date", "footer", "header", "media", "object", "picture", "sldImage", "sldNumber", "subTitle", "table", "title"). + * @param {PlaceholderType} sType - Placeholder type * @returns {boolean} - returns false if placeholder type doesn't exist. */ ApiPlaceholder.prototype.SetType = function(sType){ return true; }; +/** + * Returns the placeholder type. + * @returns {PlaceholderType} - Returns the placeholder type. + * @since 8.2.0 + */ +ApiPlaceholder.prototype.GetType = function(){ return new PlaceholderType(); }; + +/** + * Returns the placeholder type. + * @returns {PlaceholderType} - Returns the placeholder type. + * @since 8.2.0 + */ +ApiPlaceholder.prototype.Type = ApiPlaceholder.prototype.GetType (); + +/** + * Sets the placeholder index. + * @param {number} nIdx - The placeholder index. + * @returns {boolean} - Returns false if the placeholder index wasn't set. + * @since 8.2.0 + */ +ApiPlaceholder.prototype.SetIndex = function(nIdx){ return true; }; + +/** + * Retuns the placeholder index. + * @returns {number | undefined} - Returns the placeholder index. + * @since 8.2.0 + */ +ApiPlaceholder.prototype.GetIndex = function(){ return 0; }; + +/** + * Retuns the placeholder index. + * @returns {number | undefined} - Returns the placeholder index. + * @since 8.2.0 + */ +ApiPlaceholder.prototype.Index = ApiPlaceholder.prototype.GetIndex (); + /** * Returns the type of the ApiTheme class. - * @typeofeditors ["CPE"] * @returns {"theme"} */ ApiTheme.prototype.GetClassType = function(){ return ""; }; /** * Returns the slide master of the current theme. - * @typeofeditors ["CPE"] * @returns {ApiMaster | null} - returns null if slide master doesn't exist. */ ApiTheme.prototype.GetMaster = function(){ return new ApiMaster(); }; /** * Sets the color scheme to the current presentation theme. - * @typeofeditors ["CPE"] * @param {ApiThemeColorScheme} oApiColorScheme - Theme color scheme. * @returns {boolean} - return false if color scheme doesn't exist. */ @@ -3069,14 +3983,12 @@ ApiTheme.prototype.SetColorScheme = function(oApiColorScheme){ return true; }; /** * Returns the color scheme of the current theme. - * @typeofeditors ["CPE"] * @returns {ApiThemeColorScheme} */ ApiTheme.prototype.GetColorScheme = function(){ return new ApiThemeColorScheme(); }; /** * Sets the format scheme to the current presentation theme. - * @typeofeditors ["CPE"] * @param {ApiThemeFormatScheme} oApiFormatScheme - Theme format scheme. * @returns {boolean} - return false if format scheme doesn't exist. */ @@ -3084,14 +3996,12 @@ ApiTheme.prototype.SetFormatScheme = function(oApiFormatScheme){ return true; }; /** * Returns the format scheme of the current theme. - * @typeofeditors ["CPE"] * @returns {ApiThemeFormatScheme} */ ApiTheme.prototype.GetFormatScheme = function(){ return new ApiThemeFormatScheme(); }; /** * Sets the font scheme to the current presentation theme. - * @typeofeditors ["CPE"] * @param {ApiThemeFontScheme} oApiFontScheme - Theme font scheme. * @returns {boolean} - return false if font scheme doesn't exist. */ @@ -3099,21 +4009,18 @@ ApiTheme.prototype.SetFontScheme = function(oApiFontScheme){ return true; }; /** * Returns the font scheme of the current theme. - * @typeofeditors ["CPE"] * @returns {ApiThemeFontScheme} */ ApiTheme.prototype.GetFontScheme = function(){ return new ApiThemeFontScheme(); }; /** * Returns the type of the ApiThemeColorScheme class. - * @typeofeditors ["CPE"] * @returns {"themeColorScheme"} */ ApiThemeColorScheme.prototype.GetClassType = function(){ return ""; }; /** * Sets a name to the current theme color scheme. - * @typeofeditors ["CPE"] * @param {string} sName - Theme color scheme name. * @returns {boolean} */ @@ -3121,7 +4028,6 @@ ApiThemeColorScheme.prototype.SetSchemeName = function(sName){ return true; }; /** * Changes a color in the theme color scheme. - * @typeofeditors ["CPE"] * @param {number} nPos - Color position in the color scheme which will be changed. * @param {ApiUniColor | ApiRGBColor} oColor - New color of the theme color scheme. * @returns {boolean} @@ -3130,7 +4036,6 @@ ApiThemeColorScheme.prototype.ChangeColor = function(nPos, oColor){ return true; /** * Creates a copy of the current theme color scheme. - * @typeofeditors ["CPE"] * @returns {ApiThemeColorScheme} */ ApiThemeColorScheme.prototype.Copy = function(){ return new ApiThemeColorScheme(); }; @@ -3138,21 +4043,18 @@ ApiThemeColorScheme.prototype.Copy = function(){ return new ApiThemeColorScheme( /** * Converts the ApiThemeColorScheme object into the JSON object. * @memberof ApiThemeColorScheme - * @typeofeditors ["CPE"] * @returns {JSON} */ ApiThemeColorScheme.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns the type of the ApiThemeFormatScheme class. - * @typeofeditors ["CPE"] * @returns {"themeFormatScheme"} */ ApiThemeFormatScheme.prototype.GetClassType = function(){ return ""; }; /** * Sets a name to the current theme format scheme. - * @typeofeditors ["CPE"] * @param {string} sName - Theme format scheme name. * @returns {boolean} */ @@ -3160,7 +4062,6 @@ ApiThemeFormatScheme.prototype.SetSchemeName = function(sName){ return true; }; /** * Sets the fill styles to the current theme format scheme. - * @typeofeditors ["CPE"] * @param {ApiFill[]} arrFill - The array of fill styles must contain 3 elements - subtle, moderate and intense fills. * If an array is empty or NoFill elements are in the array, it will be filled with the Api.CreateNoFill() elements. */ @@ -3168,7 +4069,6 @@ ApiThemeFormatScheme.prototype.ChangeFillStyles = function(arrFill){}; /** * Sets the background fill styles to the current theme format scheme. - * @typeofeditors ["CPE"] * @param {ApiFill[]} arrBgFill - The array of background fill styles must contains 3 elements - subtle, moderate and intense fills. * If an array is empty or NoFill elements are in the array, it will be filled with the Api.CreateNoFill() elements. */ @@ -3176,25 +4076,22 @@ ApiThemeFormatScheme.prototype.ChangeBgFillStyles = function(arrBgFill){}; /** * Sets the line styles to the current theme format scheme. - * @typeofeditors ["CPE"] * @param {ApiStroke[]} arrLine - The array of line styles must contain 3 elements - subtle, moderate and intense fills. * If an array is empty or ApiStroke elements are with no fill, it will be filled with the Api.CreateStroke(0, Api.CreateNoFill()) elements. */ ApiThemeFormatScheme.prototype.ChangeLineStyles = function(arrLine){}; /** - * **Need to do** - * Sets the effect styles to the current theme format scheme. - * @typeofeditors ["CPE"] - * @param {?Array} arrEffect - The array of effect styles must contain 3 elements - subtle, moderate and intense fills. - * If an array is empty or NoFill elements are in the array, it will be filled with the Api.CreateStroke(0, Api.CreateNoFill()) elements. - * @returns {boolean} - */ -ApiThemeFormatScheme.prototype.ChangeEffectStyles = function(arrEffect){ return true; }; +// * **Need to do** +// * Sets the effect styles to the current theme format scheme. +// * @param {?Array} arrEffect - The array of effect styles must contain 3 elements - subtle, moderate and intense fills. +// * If an array is empty or NoFill elements are in the array, it will be filled with the Api.CreateStroke(0, Api.CreateNoFill()) elements. +// * @returns {boolean} +// */ +// ApiThemeFormatScheme.prototype.ChangeEffectStyles = function(arrEffect){ return true; }; /** * Creates a copy of the current theme format scheme. - * @typeofeditors ["CPE"] * @returns {ApiThemeFormatScheme} */ ApiThemeFormatScheme.prototype.Copy = function(){ return new ApiThemeFormatScheme(); }; @@ -3202,21 +4099,18 @@ ApiThemeFormatScheme.prototype.Copy = function(){ return new ApiThemeFormatSchem /** * Converts the ApiThemeFormatScheme object into the JSON object. * @memberof ApiThemeFormatScheme - * @typeofeditors ["CPE"] * @returns {JSON} */ ApiThemeFormatScheme.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns the type of the ApiThemeFontScheme class. - * @typeofeditors ["CPE"] * @returns {"themeFontScheme"} */ ApiThemeFontScheme.prototype.GetClassType = function(){ return ""; }; /** * Sets a name to the current theme font scheme. - * @typeofeditors ["CPE"] * @param {string} sName - Theme font scheme name. * @returns {boolean} - returns false if font scheme doesn't exist. */ @@ -3224,7 +4118,6 @@ ApiThemeFontScheme.prototype.SetSchemeName = function(sName){ return true; }; /** * Sets the fonts to the current theme font scheme. - * @typeofeditors ["CPE"] * @memberof ApiThemeFontScheme * @param {string} mjLatin - The major theme font applied to the latin text. * @param {string} mjEa - The major theme font applied to the east asian text. @@ -3237,7 +4130,6 @@ ApiThemeFontScheme.prototype.SetFonts = function(mjLatin, mjEa, mjCs, mnLatin, m /** * Creates a copy of the current theme font scheme. - * @typeofeditors ["CPE"] * @returns {ApiThemeFontScheme} */ ApiThemeFontScheme.prototype.Copy = function(){ return new ApiThemeFontScheme(); }; @@ -3245,37 +4137,45 @@ ApiThemeFontScheme.prototype.Copy = function(){ return new ApiThemeFontScheme(); /** * Converts the ApiThemeFontScheme object into the JSON object. * @memberof ApiThemeFontScheme - * @typeofeditors ["CPE"] * @returns {JSON} */ ApiThemeFontScheme.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns the type of the ApiSlide class. - * @typeofeditors ["CPE"] * @returns {"slide"} */ ApiSlide.prototype.GetClassType = function(){ return ""; }; /** * Removes all the objects from the current slide. - * @typeofeditors ["CPE"] * @memberof ApiSlide */ ApiSlide.prototype.RemoveAllObjects = function(){}; /** * Adds an object (image, shape or chart) to the current presentation slide. - * @typeofeditors ["CPE"] * @memberof ApiSlide * @param {ApiDrawing} oDrawing - The object which will be added to the current presentation slide. * @returns {boolean} - returns false if slide doesn't exist. */ ApiSlide.prototype.AddObject = function(oDrawing){ return true; }; +/** + * Adds a comment to the current slide. + * + * @memberof ApiSlide + * @param {number} posX - The X position (in EMU) of the comment (defaults to 0). + * @param {number} posY - The Y position (in EMU) of the comment (defaults to 0). + * @param {string} text - The comment text. + * @param {string} [author] - The author's name (defaults to the current user name). + * @param {string} [userId] - The user ID of the comment author (defaults to the current user ID). + * @returns {boolean} + */ +ApiSlide.prototype.AddComment = function (posX, posY, text, author, userId) { return true; }; + /** * Removes objects (image, shape or chart) from the current slide. - * @typeofeditors ["CPE"] * @memberof ApiSlide * @param {number} nPos - Position from which the object will be deleted. * @param {number} [nCount = 1] - The number of elements to delete. @@ -3286,181 +4186,225 @@ ApiSlide.prototype.RemoveObject = function(nPos, nCount){ return true; }; /** * Sets the background to the current presentation slide. * @memberOf ApiSlide - * @typeofeditors ["CPE"] * @param {ApiFill} oApiFill - The color or pattern used to fill the presentation slide background. * @returns {boolean} - * */ + */ ApiSlide.prototype.SetBackground = function(oApiFill){ return true; }; /** * Returns the visibility of the current presentation slide. * @memberOf ApiSlide - * @typeofeditors ["CPE"] * @returns {boolean} - * */ + */ ApiSlide.prototype.GetVisible = function(){ return true; }; /** * Sets the visibility to the current presentation slide. * @memberOf ApiSlide - * @typeofeditors ["CPE"] * @param {boolean} value - Slide visibility. * @returns {boolean} - * */ + */ ApiSlide.prototype.SetVisible = function(value){ return true; }; /** * Returns the slide width in English measure units. - * @typeofeditors ["CPE"] * @returns {EMU} - * */ + */ ApiSlide.prototype.GetWidth = function(){ return new EMU(); }; /** * Returns the slide height in English measure units. - * @typeofeditors ["CPE"] * @returns {EMU} - * */ + */ ApiSlide.prototype.GetHeight = function(){ return new EMU(); }; /** * Applies the specified layout to the current slide. * The layout must be in slide master. - * @typeofeditors ["CPE"] * @param {ApiLayout} oLayout - Layout to be applied. * @returns {boolean} - returns false if slide doesn't exist. - * */ + */ ApiSlide.prototype.ApplyLayout = function(oLayout){ return true; }; /** * Deletes the current slide from the presentation. - * @typeofeditors ["CPE"] * @returns {boolean} - returns false if slide doesn't exist or is not in the presentation. - * */ + */ ApiSlide.prototype.Delete = function(){ return true; }; /** * Creates a copy of the current slide object. - * @typeofeditors ["CPE"] * @returns {ApiSlide | null} - returns new ApiSlide object that represents the duplicate slide. * Returns null if slide doesn't exist. - * */ + */ ApiSlide.prototype.Copy = function(){ return new ApiSlide(); }; /** * Creates a duplicate of the specified slide object, adds the new slide to the slides collection. - * @typeofeditors ["CPE"] * @param {number} [nPos = ApiPresentation.GetSlidesCount()] - Position where the new slide will be added. * @returns {ApiSlide | null} - returns new ApiSlide object that represents the duplicate slide. * Returns null if slide doesn't exist or is not in the presentation. - * */ + */ ApiSlide.prototype.Duplicate = function(nPos){ return new ApiSlide(); }; /** * Moves the current slide to a specific location within the same collection. - * @typeofeditors ["CPE"] * @param {number} nPos - Position where the current slide will be moved to. * @returns {boolean} - returns false if slide doesn't exist or position is invalid or slide is not in the presentation. - * */ + */ ApiSlide.prototype.MoveTo = function(nPos){ return true; }; /** * Returns a position of the current slide in the presentation. - * @typeofeditors ["CPE"] * @returns {number} - returns -1 if slide doesn't exist or is not in the presentation. - * */ + */ ApiSlide.prototype.GetSlideIndex = function (){ return 0; }; /** * Clears the slide background. - * @typeofeditors ["CPE"] * @returns {boolean} - return false if slide doesn't exist. - * */ + */ ApiSlide.prototype.ClearBackground = function(){ return true; }; /** * Sets the layout background as the background of the slide. - * @typeofeditors ["CPE"] * @returns {boolean} - returns false if layout is null or layout hasn't background or slide doesn't exist. - * */ + */ ApiSlide.prototype.FollowLayoutBackground = function(){ return true; }; /** * Sets the master background as the background of the slide. - * @typeofeditors ["CPE"] * @returns {boolean} - returns false if master is null or master hasn't background or slide doesn't exist. - * */ + */ ApiSlide.prototype.FollowMasterBackground = function(){ return true; }; /** * Applies the specified theme to the current slide. - * @typeofeditors ["CPE"] * @param {ApiTheme} oApiTheme - Presentation theme. * @returns {boolean} - returns false if master is null or master hasn't background. - * */ + */ ApiSlide.prototype.ApplyTheme = function(oApiTheme){ return true; }; /** * Returns a layout of the current slide. - * @typeofeditors ["CPE"] * @returns {ApiLayout | null} - returns null if slide or layout doesn't exist. - * */ + */ ApiSlide.prototype.GetLayout = function(){ return new ApiLayout(); }; /** * Returns a theme of the current slide. - * @typeofeditors ["CPE"] * @returns {ApiTheme} - returns null if slide or layout or master or theme doesn't exist. - * */ + */ ApiSlide.prototype.GetTheme = function(){ return new ApiTheme(); }; /** * Returns an array with all the drawing objects from the slide. - * @typeofeditors ["CPE"] - * @returns {ApiDrawing[]} - * */ -ApiSlide.prototype.GetAllDrawings = function(){ return [new ApiDrawing()]; }; + * @returns {Drawing[]} + */ +ApiSlide.prototype.GetAllDrawings = function(){ return [new Drawing()]; }; /** * Returns an array with all the shape objects from the slide. - * @typeofeditors ["CPE"] * @returns {ApiShape[]} - * */ + */ ApiSlide.prototype.GetAllShapes = function(){ return [new ApiShape()]; }; /** * Returns an array with all the image objects from the slide. - * @typeofeditors ["CPE"] * @returns {ApiImage[]} - * */ -ApiSlide.prototype.GetAllImages = function(){ return [new ApiImage()]; }; + */ +ApiSlide.prototype.GetAllImages = function() { return [new ApiImage()]; }; /** * Returns an array with all the chart objects from the slide. - * @typeofeditors ["CPE"] * @returns {ApiChart[]} - * */ -ApiSlide.prototype.GetAllCharts = function(){ return [new ApiChart()]; }; + */ +ApiSlide.prototype.GetAllCharts = function() { return [new ApiChart()]; }; /** * Returns an array with all the OLE objects from the slide. - * @typeofeditors ["CPE"] * @returns {ApiOleObject[]} - * */ -ApiSlide.prototype.GetAllOleObjects = function(){ return [new ApiOleObject()]; }; + */ +ApiSlide.prototype.GetAllOleObjects = function() { return [new ApiOleObject()]; }; /** * Converts the ApiSlide object into the JSON object. * @memberof ApiSlide - * @typeofeditors ["CPE"] - * @param {bool} [bWriteLayout=false] - Specifies if the slide layout will be written to the JSON object or not. - * @param {bool} [bWriteMaster=false] - Specifies if the slide master will be written to the JSON object or not (bWriteMaster is false if bWriteLayout === false). - * @param {bool} [bWriteAllMasLayouts=false] - Specifies if all child layouts from the slide master will be written to the JSON object or not. - * @param {bool} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). + * @param {boolean} [bWriteLayout=false] - Specifies if the slide layout will be written to the JSON object or not. + * @param {boolean} [bWriteMaster=false] - Specifies if the slide master will be written to the JSON object or not (bWriteMaster is false if bWriteLayout === false). + * @param {boolean} [bWriteAllMasLayouts=false] - Specifies if all child layouts from the slide master will be written to the JSON object or not. + * @param {boolean} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). * @returns {JSON} */ ApiSlide.prototype.ToJSON = function(bWriteLayout, bWriteMaster, bWriteAllMasLayouts, bWriteTableStyles){ return new JSON(); }; +/** + * Returns an array of drawings by the specified placeholder type. + * @memberof ApiSlide + * @param {PlaceholderType} sType - The placeholder type. + * @returns {Drawing[]} + * @since 8.2.0 + */ +ApiSlide.prototype.GetDrawingsByPlaceholderType = function(sType) { return [new Drawing()]; }; + +/** + * Selects the current slide. + * @memberof ApiSlide + * @since 8.3.0 + */ +ApiSlide.prototype.Select = function() {}; + +/** + * Groups an array of drawings in the current slide. + * @memberof ApiSlide + * @param {DrawingForGroup[]} aDrawings - An array of drawings to group. + * @returns {ApiGroup} + * @since 8.3.0 + */ +ApiSlide.prototype.GroupDrawings = function(aDrawings){ return new ApiGroup(); }; + +/** + * Returns the notes page from the current slide. + * @memberof ApiSlide + * @returns {ApiNotesPage | null} + * @since 9.0.0 + */ +ApiSlide.prototype.GetNotesPage = function () { return new ApiNotesPage(); }; + +/** + * Adds a text to the notes page of the current slide. + * @memberof ApiSlide + * @param {string} sText - The text to be added to the notes page. + * @returns {boolean} - Returns true if text was added successfully, otherwise false. + * @since 9.0.0 + */ +ApiSlide.prototype.AddNotesText = function (sText) { return true; }; + +/** + * Returns the type of the ApiNotesPage class. + * + * @returns {"notesPage"} + * @since 9.0.0 + */ +ApiNotesPage.prototype.GetClassType = function () { return ""; }; + +/** + * Returns a shape with the type="body" attribute from the current notes page. + * @memberof ApiNotesPage + * @returns {ApiShape | null} + * @since 9.0.0 + */ +ApiNotesPage.prototype.GetBodyShape = function () { return new ApiShape(); }; + +/** + * Adds a text to the body shape of the current notes page. + * @memberof ApiNotesPage + * @param {string} sText - The text to be added to the body shape. + * @returns {boolean} - Returns true if text was added successfully, otherwise false. + * @since 9.0.0 + */ +ApiNotesPage.prototype.AddBodyShapeText = function (sText) { return true; }; + /** * Returns the type of the ApiDrawing class. * @returns {"drawing"} @@ -3483,49 +4427,42 @@ ApiDrawing.prototype.SetPosition = function(nPosX, nPosY){}; /** * Returns the drawing parent object. - * @typeofeditors ["CPE"] * @returns {ApiSlide | ApiLayout | ApiMaster | null} */ ApiDrawing.prototype.GetParent = function(){ return new ApiSlide(); }; /** * Returns the drawing parent slide. - * @typeofeditors ["CPE"] * @returns {ApiSlide | null} - return null if parent ins't a slide. */ ApiDrawing.prototype.GetParentSlide = function(){ return new ApiSlide(); }; /** * Returns the drawing parent slide layout. - * @typeofeditors ["CPE"] * @returns {ApiLayout | null} - return null if parent ins't a slide layout. */ ApiDrawing.prototype.GetParentLayout = function(){ return new ApiLayout(); }; /** * Returns the drawing parent slide master. - * @typeofeditors ["CPE"] * @returns {ApiMaster | null} - return null if parent ins't a slide master. */ ApiDrawing.prototype.GetParentMaster = function(){ return new ApiMaster(); }; /** * Creates a copy of the specified drawing object. - * @typeofeditors ["CPE"] * @returns {ApiDrawing} - return null if drawing doesn't exist. */ ApiDrawing.prototype.Copy = function(){ return new ApiDrawing(); }; /** * Deletes the specified drawing object from the parent. - * @typeofeditors ["CPE"] * @returns {boolean} - false if drawing doesn't exist or drawing hasn't a parent. */ ApiDrawing.prototype.Delete = function(){ return true; }; /** * Sets the specified placeholder to the current drawing object. - * @typeofeditors ["CPE"] * @param {ApiPlaceholder} oPlaceholder - Placeholder object. * @returns {boolean} - returns false if parameter isn't a placeholder. */ @@ -3533,7 +4470,6 @@ ApiDrawing.prototype.SetPlaceholder = function(oPlaceholder){ return true; }; /** * Returns a placeholder from the current drawing object. - * @typeofeditors ["CPE"] * @returns {ApiPlaceholder | null} - returns null if placeholder doesn't exist. */ ApiDrawing.prototype.GetPlaceholder = function(){ return new ApiPlaceholder(); }; @@ -3541,7 +4477,6 @@ ApiDrawing.prototype.GetPlaceholder = function(){ return new ApiPlaceholder(); } /** * Returns the width of the current drawing. * @memberof ApiDrawing - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {EMU} */ ApiDrawing.prototype.GetWidth = function(){ return new EMU(); }; @@ -3549,38 +4484,72 @@ ApiDrawing.prototype.GetWidth = function(){ return new EMU(); }; /** * Returns the height of the current drawing. * @memberof ApiDrawing - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {EMU} */ ApiDrawing.prototype.GetHeight = function(){ return new EMU(); }; /** * Returns the lock value for the specified lock type of the current drawing. - * @typeofeditors ["CPE"] - * @param {"noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" - * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox"} sType - Lock type in the string format. - * @returns {bool} + * @param {DrawingLockType} sType - Lock type in the string format. + * @returns {boolean} */ ApiDrawing.prototype.GetLockValue = function(sType){ return true; }; /** * Sets the lock value to the specified lock type of the current drawing. - * @typeofeditors ["CPE"] - * @param {"noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" - * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox"} sType - Lock type in the string format. - * @param {bool} bValue - Specifies if the specified lock is applied to the current drawing. - * @returns {bool} + * @param {DrawingLockType} sType - Lock type in the string format. + * @param {boolean} bValue - Specifies if the specified lock is applied to the current drawing. + * @returns {boolean} */ ApiDrawing.prototype.SetLockValue = function(sType, bValue){ return true; }; /** * Converts the ApiDrawing object into the JSON object. * @memberof ApiDrawing - * @typeofeditors ["CPE"] * @returns {JSON} */ ApiDrawing.prototype.ToJSON = function(){ return new JSON(); }; +/** + * Selects the current graphic object. + * @memberof ApiDrawing + * @since 8.2.0 + */ +ApiDrawing.prototype.Select = function() {}; + +/** + * Sets the rotation angle to the current drawing object. + * @memberof ApiDrawing + * @param {number} nRotAngle - New drawing rotation angle. + * @returns {boolean} + * @since 9.0.0 + */ +ApiDrawing.prototype.SetRotation = function(nRotAngle){ return true; }; + +/** + * Returns the rotation angle of the current drawing object. + * @memberof ApiDrawing + * @returns {number} + * @since 9.0.0 + */ +ApiDrawing.prototype.GetRotation = function(){ return 0; }; + +/** + * Returns a type of the ApiGroup class. + * @memberof ApiGroup + * @returns {"group"} + * @since 8.3.0 + */ +ApiGroup.prototype.GetClassType = function(){ return ""; }; + +/** + * Ungroups the current group of drawings. + * @memberof ApiGroup + * @returns {boolean} + * @since 8.3.0 + */ +ApiGroup.prototype.Ungroup = function(){ return true; }; + /** * Returns the type of the ApiImage class. * @returns {"image"} @@ -3589,7 +4558,6 @@ ApiImage.prototype.GetClassType = function(){ return ""; }; /** * Returns the type of the ApiShape class. - * @typeofeditors ["CPE"] * @returns {"shape"} */ ApiShape.prototype.GetClassType = function(){ return ""; }; @@ -3597,396 +4565,25 @@ ApiShape.prototype.GetClassType = function(){ return ""; }; /** * Deprecated in 6.2. * Returns the shape inner contents where a paragraph or text runs can be inserted. - * @typeofeditors ["CPE"] * @returns {ApiDocumentContent} */ ApiShape.prototype.GetDocContent = function(){ return new ApiDocumentContent(); }; /** * Returns the shape inner contents where a paragraph or text runs can be inserted. - * @typeofeditors ["CPE"] * @returns {ApiDocumentContent} */ ApiShape.prototype.GetContent = function(){ return new ApiDocumentContent(); }; /** * Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. - * @typeofeditors ["CPE"] * @param {VerticalTextAlign} VerticalAlign - The type of the vertical alignment for the shape inner contents. */ ApiShape.prototype.SetVerticalTextAlign = function(VerticalAlign){}; -/** - * Returns the type of the ApiChart class. - * @typeofeditors ["CPE"] - * @returns {"chart"} - */ -ApiChart.prototype.GetClassType = function(){ return ""; }; - -/** - * Specifies the chart title. - * @typeofeditors ["CPE"] - * @param {string} sTitle - The title which will be displayed for the current chart. - * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the chart title is written in bold font or not. - */ -ApiChart.prototype.SetTitle = function (sTitle, nFontSize, bIsBold){}; - -/** - * Specifies the chart horizontal axis title. - * @typeofeditors ["CPE"] - * @param {string} sTitle - The title which will be displayed for the horizontal axis of the current chart. - * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the horizontal axis title is written in bold font or not. - * */ -ApiChart.prototype.SetHorAxisTitle = function (sTitle, nFontSize, bIsBold){}; - -/** - * Specifies the chart vertical axis title. - * @typeofeditors ["CPE"] - * @param {string} sTitle - The title which will be displayed for the vertical axis of the current chart. - * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the vertical axis title is written in bold font or not. - * */ -ApiChart.prototype.SetVerAxisTitle = function (sTitle, nFontSize, bIsBold){}; - -/** - * Specifies the chart legend position. - * @typeofeditors ["CPE"] - * @param {"left" | "top" | "right" | "bottom" | "none"} sLegendPos - The position of the chart legend inside the chart window. - * */ -ApiChart.prototype.SetLegendPos = function(sLegendPos){}; - -/** - * Specifies the chart legend font size. - * @param {pt} nFontSize - The text size value measured in points. - * */ -ApiChart.prototype.SetLegendFontSize = function(nFontSize){}; - -/** - * Specifies the vertical axis orientation. - * @param {boolean} bIsMinMax - The true value will set the normal data direction for the vertical axis - * (from minimum to maximum). The false value will set the inverted data direction for the vertical axis (from maximum to minimum). - * */ -ApiChart.prototype.SetVerAxisOrientation = function(bIsMinMax){}; - -/** - * Specifies the horizontal axis orientation. - * @param {boolean} bIsMinMax - The true value will set the normal data direction for the horizontal axis - * (from minimum to maximum). The false value will set the inverted data direction for the horizontal axis (from maximum to minimum). - * */ -ApiChart.prototype.SetHorAxisOrientation = function(bIsMinMax){}; - -/** - * Specifies which chart data labels are shown for the chart. - * @typeofeditors ["CPE"] - * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. - * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. - * @param {boolean} bShowVal - Whether to show or hide the chart data values. - * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). - * */ -ApiChart.prototype.SetShowDataLabels = function(bShowSerName, bShowCatName, bShowVal, bShowPercent){}; - -/** - * Spicifies the show options for the chart data labels. - * @param {number} nSeriesIndex - The series index from the array of the data used to build the chart from. - * @param {number} nPointIndex - The point index from this series. - * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. - * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. - * @param {boolean} bShowVal - Whether to show or hide the chart data values. - * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). - * */ -ApiChart.prototype.SetShowPointDataLabel = function(nSeriesIndex, nPointIndex, bShowSerName, bShowCatName, bShowVal, bShowPercent){}; - -/** - * Spicifies tick label position for the vertical axis. - * @param {TickLabelPosition} sTickLabelPosition - The position type of the chart vertical tick labels. - * */ -ApiChart.prototype.SetVertAxisTickLabelPosition = function(sTickLabelPosition){}; - -/** - * Spicifies tick label position for the horizontal axis. - * @param {TickLabelPosition} sTickLabelPosition - The position type of the chart horizontal tick labels. - * */ -ApiChart.prototype.SetHorAxisTickLabelPosition = function(sTickLabelPosition){}; - -/** - * Specifies the major tick mark for the horizontal axis. - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetHorAxisMajorTickMark = function(sTickMark){}; - -/** - * Specifies the minor tick mark for the horizontal axis. - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetHorAxisMinorTickMark = function(sTickMark){}; - -/** - * Specifies the major tick mark for the vertical axis. - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetVertAxisMajorTickMark = function(sTickMark){}; - -/** - * Specifies the minor tick mark for the vertical axis. - * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetVertAxisMinorTickMark = function(sTickMark){}; - -/** - * Specifies the visual properties for the major vertical gridlines. - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMajorVerticalGridlines = function(oStroke){}; - -/** - * Specifies the visual properties for the minor vertical gridlines. - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMinorVerticalGridlines = function(oStroke){}; - -/** - * Specifies the visual properties for the major horizontal gridlines. - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMajorHorizontalGridlines = function(oStroke){}; - -/** - * Specifies the visual properties for the minor horizontal gridlines. - * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMinorHorizontalGridlines = function(oStroke){}; - -/** - * Specifies font size for the labels of the horizontal axis. - * @param {pt} nFontSize - The text size value measured in points. - */ -ApiChart.prototype.SetHorAxisLablesFontSize = function(nFontSize){}; - -/** - * Specifies font size for the labels of the vertical axis. - * @param {pt} nFontSize - The text size value measured in points. - */ -ApiChart.prototype.SetVertAxisLablesFontSize = function(nFontSize){}; - -/** - * Removes the specified series from the current chart. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {number} nSeria - The index of the chart series. - * @returns {boolean} - */ -ApiChart.prototype.RemoveSeria = function(nSeria){ return true; }; - -/** - * Sets values to the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] - * @param {number[]} aValues - The array of the data which will be set to the specified chart series. - * @param {number} nSeria - The index of the chart series. - * @returns {boolean} - */ -ApiChart.prototype.SetSeriaValues = function(aValues, nSeria){ return true; }; - -/** - * Sets the x-axis values to all chart series. It is used with the scatter charts only. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] - * @param {string[]} aValues - The array of the data which will be set to the x-axis data points. - * @returns {boolean} - */ -ApiChart.prototype.SetXValues = function(aValues){ return true; }; - -/** - * Sets a name to the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] - * @param {string} sName - The name which will be set to the specified chart series. - * @param {number} nSeria - The index of the chart series. - * @returns {boolean} - */ -ApiChart.prototype.SetSeriaName = function(sName, nSeria){ return true; }; - -/** - * Sets a name to the specified chart category. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] - * @param {string} sName - The name which will be set to the specified chart category. - * @param {number} nCategory - The index of the chart category. - * @returns {boolean} - */ -ApiChart.prototype.SetCategoryName = function(sName, nCategory){ return true; }; - -/** - * Sets a style to the current chart by style ID. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param nStyleId - One of the styles available in the editor. - * @returns {boolean} - */ -ApiChart.prototype.ApplyChartStyle = function(nStyleId){ return true; }; - -/** - * Sets the fill to the chart plot area. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the plot area. - * @returns {boolean} - */ -ApiChart.prototype.SetPlotAreaFill = function(oFill){ return true; }; - -/** - * Sets the outline to the chart plot area. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the plot area outline. - * @returns {boolean} - */ -ApiChart.prototype.SetPlotAreaOutLine = function(oStroke){ return true; }; - -/** - * Sets the fill to the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the series. - * @param {number} nSeries - The index of the chart series. - * @param {boolean} [bAll=false] - Specifies if the fill will be applied to all series. - * @returns {boolean} - */ -ApiChart.prototype.SetSeriesFill = function(oFill, nSeries, bAll){ return true; }; - -/** - * Sets the outline to the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the series outline. - * @param {number} nSeries - The index of the chart series. - * @param {boolean} [bAll=false] - Specifies if the outline will be applied to all series. - * @returns {boolean} - */ -ApiChart.prototype.SetSeriesOutLine = function(oStroke, nSeries, bAll){ return true; }; - -/** - * Sets the fill to the data point in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the data point. - * @param {number} nSeries - The index of the chart series. - * @param {number} nDataPoint - The index of the data point in the specified chart series. - * @param {boolean} [bAllSeries=false] - Specifies if the fill will be applied to the specified data point in all series. - * @returns {boolean} - */ -ApiChart.prototype.SetDataPointFill = function(oFill, nSeries, nDataPoint, bAllSeries){ return true; }; - -/** - * Sets the outline to the data point in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the data point outline. - * @param {number} nSeries - The index of the chart series. - * @param {number} nDataPoint - The index of the data point in the specified chart series. - * @param {boolean} bAllSeries - Specifies if the outline will be applied to the specified data point in all series. - * @returns {boolean} - */ -ApiChart.prototype.SetDataPointOutLine = function(oStroke, nSeries, nDataPoint, bAllSeries){ return true; }; - -/** - * Sets the fill to the marker in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the marker. - * @param {number} nSeries - The index of the chart series. - * @param {number} nMarker - The index of the marker in the specified chart series. - * @param {boolean} [bAllMarkers=false] - Specifies if the fill will be applied to all markers in the specified chart series. - * @returns {boolean} - */ -ApiChart.prototype.SetMarkerFill = function(oFill, nSeries, nMarker, bAllMarkers){ return true; }; - -/** - * Sets the outline to the marker in the specified chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the marker outline. - * @param {number} nSeries - The index of the chart series. - * @param {number} nMarker - The index of the marker in the specified chart series. - * @param {boolean} [bAllMarkers=false] - Specifies if the outline will be applied to all markers in the specified chart series. - * @returns {boolean} - */ -ApiChart.prototype.SetMarkerOutLine = function(oStroke, nSeries, nMarker, bAllMarkers){ return true; }; - -/** - * Sets the fill to the chart title. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the title. - * @returns {boolean} - */ -ApiChart.prototype.SetTitleFill = function(oFill){ return true; }; - -/** - * Sets the outline to the chart title. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the title outline. - * @returns {boolean} - */ -ApiChart.prototype.SetTitleOutLine = function(oStroke){ return true; }; - -/** - * Sets the fill to the chart legend. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiFill} oFill - The fill type used to fill the legend. - * @returns {boolean} - */ -ApiChart.prototype.SetLegendFill = function(oFill){ return true; }; - -/** - * Sets the outline to the chart legend. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {ApiStroke} oStroke - The stroke used to create the legend outline. - * @returns {boolean} - */ -ApiChart.prototype.SetLegendOutLine = function(oStroke){ return true; }; - -/** - * Sets the specified numeric format to the axis values. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {NumFormat | String} sFormat - Numeric format (can be custom format). - * @param {AxisPos} - Axis position. - * @returns {boolean} - */ -ApiChart.prototype.SetAxieNumFormat = function(sFormat, sAxiePos){ return true; }; - -/** - * Sets the specified numeric format to the chart series. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] - * @param {NumFormat | String} sFormat - Numeric format (can be custom format). - * @param {Number} nSeria - Series index. - * @returns {boolean} - */ -ApiChart.prototype.SetSeriaNumFormat = function(sFormat, nSeria){ return true; }; - -/** - * Sets the specified numeric format to the chart data point. - * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] - * @param {NumFormat | String} sFormat - Numeric format (can be custom format). - * @param {Number} nSeria - Series index. - * @param {number} nDataPoint - The index of the data point in the specified chart series. - * @param {boolean} bAllSeries - Specifies if the numeric format will be applied to the specified data point in all series. - * @returns {boolean} - */ -ApiChart.prototype.SetDataPointNumFormat = function(sFormat, nSeria, nDataPoint, bAllSeries){ return true; }; - /** * Returns a type of the ApiOleObject class. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {"oleObject"} */ ApiOleObject.prototype.GetClassType = function(){ return ""; }; @@ -3994,7 +4591,6 @@ ApiOleObject.prototype.GetClassType = function(){ return ""; }; /** * Sets the data to the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {string} sData - The OLE object string data. * @returns {boolean} */ @@ -4003,7 +4599,6 @@ ApiOleObject.prototype.SetData = function(sData){ return true; }; /** * Returns the string data from the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiOleObject.prototype.GetData = function(){ return ""; }; @@ -4011,7 +4606,6 @@ ApiOleObject.prototype.GetData = function(){ return ""; }; /** * Sets the application ID to the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {string} sAppId - The application ID associated with the current OLE object. * @returns {boolean} */ @@ -4020,7 +4614,6 @@ ApiOleObject.prototype.SetApplicationId = function(sAppId){ return true; }; /** * Returns the application ID from the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiOleObject.prototype.GetApplicationId = function(){ return ""; }; @@ -4028,14 +4621,14 @@ ApiOleObject.prototype.GetApplicationId = function(){ return ""; }; /** * Returns the type of the ApiTable object. * @returns {"table"} - * */ + */ ApiTable.prototype.GetClassType = function(){ return ""; }; /** * Returns a row by its index. * @param nIndex {number} - The row index (position) in the table. * @returns {ApiTableRow} - * */ + */ ApiTable.prototype.GetRow = function(nIndex){ return new ApiTableRow(); }; /** @@ -4100,7 +4693,6 @@ ApiTable.prototype.RemoveColumn = function(oCell){ return true; }; /** * Specifies the shading which shall be applied to the extents of the current table. - * @typeofeditors ["CPE"] * @param {ShdType | ApiFill} sType - The shading type applied to the contents of the current table. Can be ShdType or ApiFill. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. @@ -4111,8 +4703,7 @@ ApiTable.prototype.SetShd = function(sType, r, g, b){}; /** * Converts the ApiTable object into the JSON object. * @memberof ApiTable - * @typeofeditors ["CPE"] - * @param {bool} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). + * @param {boolean} [bWriteTableStyles=false] - Specifies whether to write used table styles to the JSON object (true) or not (false). * @returns {JSON} */ ApiTable.prototype.ToJSON = function(bWriteTableStyles){ return new JSON(); }; @@ -4156,7 +4747,6 @@ ApiTableCell.prototype.GetContent = function(){ return new ApiDocumentContent(); /** * Specifies the shading which shall be applied to the extents of the current table cell. - * @typeofeditors ["CPE"] * @param {ShdType | ApiFill} sType - The shading type applied to the contents of the current table. Can be ShdType or ApiFill. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. @@ -4230,4 +4820,40 @@ ApiTableCell.prototype.SetCellBorderTop = function(fSize, oApiFill){}; */ ApiTableCell.prototype.SetVerticalAlign = function(sType){}; +/** + * Specifies the direction of the text flow for the current table cell. + * @param {("lrtb" | "tbrl" | "btlr")} sType - The type of the text flow direction. + */ +ApiTableCell.prototype.SetTextDirection = function(sType){}; + +/** + * Class representing the selection in the presentation. + * @constructor + */ +function ApiSelection() {} + +/** + * Returns the type of the current selection. + * @memberof ApiSelection + * @returns {SelectionType} + * @since 8.3.0 + */ +ApiSelection.prototype.GetType = function() { return new SelectionType(); }; + +/** + * Returns the selected shapes. + * @memberof ApiSelection + * @returns {ApiDrawing[]} + * @since 8.3.0 + */ +ApiSelection.prototype.GetShapes = function() { return [new ApiDrawing()]; }; + +/** + * Returns the selected slides. + * @memberof ApiSelection + * @returns {ApiSlide[]} + * @since 8.3.0 + */ +ApiSelection.prototype.GetSlides = function() { return [new ApiSlide()]; }; + diff --git a/vendor/monaco/libs/word/api.js b/vendor/monaco/libs/word/api.js index b48b6546f1..ef756bf470 100644 --- a/vendor/monaco/libs/word/api.js +++ b/vendor/monaco/libs/word/api.js @@ -9,21 +9,24 @@ var Api = new ApiInterface(); /** - * Returns the first Run in the array specified. - * @typeofeditors ["CDE"] - * @param {Array} arrRuns - Array of Runs. - * @returns {ApiRun | null} - returns null if arrRuns is invalid. + * This element specifies the information which shall be used to establish a mapping to an XML element stored within a Custom XML. + * @typedef {Object} XmlMapping + * @property {string} prefixMapping The set of prefix mappings which shall be used to interpret the XPath expression specified in xpath. + * @property {string} xpath The XPath expression. + * @property {string} storeItemID The custom XML data identifier. + * @example + * { + * "prefixMapping": "xmlns:ns0='http://example.com/example'", + * "xpath": "//ns0:book", + * "storeItemID": "testXmlPart" + * } */ -function private_GetFirstRunInArray(arrRuns){ return null; } /** - * Returns the last Run in the array specified. - * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {Array} arrRuns - Array of Runs. - * @returns {ApiRun | null} - returns null if arrRuns is invalid. + * Class representing a bookmark in the document. + * @constructor */ -function private_GetLastRunInArray(arrRuns){ return null; } +function ApiBookmark(startMark, endMark){} /** * Class representing a container for paragraphs and tables. @@ -32,14 +35,6 @@ function private_GetLastRunInArray(arrRuns){ return null; } */ function ApiDocumentContent(Document){} -/** - * Class representing the Markdown conversion processing. - * Each Range object is determined by the position of the start and end characters. - * @constructor - */ -function CMarkdownConverter(oConfig){} -CMarkdownConverter.prototype.constructor = CMarkdownConverter; - /** * Class representing a continuous region in a document. * Each Range object is determined by the position of the start and end characters. @@ -54,7 +49,6 @@ ApiRange.prototype.constructor = ApiRange; /** * Returns a type of the ApiRange class. * @memberof ApiRange - * @typeofeditors ["CDE"] * @returns {"range"} */ ApiRange.prototype.GetClassType = function(){ return ""; }; @@ -69,17 +63,15 @@ ApiRange.prototype.GetParagraph = function(nPos){ return new ApiParagraph(); }; /** * Adds a text to the specified position. * @memberof ApiRange - * @typeofeditors ["CDE"] - * @param {String} sText - The text that will be added. - * @param {string} [sPosition = "after"] - The position where the text will be added ("before" or "after" the range specified). - * @returns {boolean} - returns false if range is empty or sText isn't string value. + * @param {String} text - The text that will be added. + * @param {"after" | "before"} [position = "after"] - The position where the text will be added ("before" or "after" the range specified). + * @returns {boolean} - returns true if the text was successfully added. */ -ApiRange.prototype.AddText = function(sText, sPosition){ return true; }; +ApiRange.prototype.AddText = function(text, position){ return true; }; /** * Adds a bookmark to the specified range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {String} sName - The bookmark name. * @returns {boolean} - returns false if range is empty. */ @@ -88,7 +80,6 @@ ApiRange.prototype.AddBookmark = function(sName){ return true; }; /** * Adds a hyperlink to the specified range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {string} sLink - The link address. * @param {string} sScreenTipText - The screen tip text. * @returns {ApiHyperlink | null} - returns null if range contains more than one paragraph or sLink is invalid. @@ -99,15 +90,13 @@ ApiRange.prototype.AddHyperlink = function(sLink, sScreenTipText){ return new Ap * Returns a text from the specified range. * @memberof ApiRange * @param {object} oPr - The resulting string display properties. - * @param {boolean} [oPr.NewLineParagraph=false] - Defines if the resulting string will include paragraph line boundaries or not. * @param {boolean} [oPr.Numbering=false] - Defines if the resulting string will include numbering or not. * @param {boolean} [oPr.Math=false] - Defines if the resulting string will include mathematical expressions or not. - * @param {string} [oPr.NewLineSeparator='\r'] - Defines how the line separator will be specified in the resulting string. - * @param {string} [oPr.TableCellSeparator='\t'] - Defines how the table cell separator will be specified in the resulting string. - * @param {string} [oPr.TableRowSeparator='\r\n'] - Defines how the table row separator will be specified in the resulting string. - * @param {string} [oPr.ParaSeparator='\r\n'] - Defines how the paragraph separator will be specified in the resulting string. - * @param {string} [oPr.TabSymbol='\t'] - Defines how the tab will be specified in the resulting string (does not apply to numbering) - * @typeofeditors ["CDE"] + * @param {string} [oPr.NewLineSeparator='\r'] - Defines how the line separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r". + * @param {string} [oPr.TableCellSeparator='\t'] - Defines how the table cell separator will be specified in the resulting string. Any symbol can be used. The default separator is "\t". + * @param {string} [oPr.TableRowSeparator='\r\n'] - Defines how the table row separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r\n". + * @param {string} [oPr.ParaSeparator='\r\n'] - Defines how the paragraph separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r\n". + * @param {string} [oPr.TabSymbol='\t'] - Defines how the tab will be specified in the resulting string (does not apply to numbering). Any symbol can be used. The default symbol is "\t". * @returns {String} - returns "" if range is empty. */ ApiRange.prototype.GetText = function(oPr){ return ""; }; @@ -115,7 +104,6 @@ ApiRange.prototype.GetText = function(oPr){ return ""; }; /** * Returns a collection of paragraphs that represents all the paragraphs in the specified range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @returns {ApiParagraph[]} */ ApiRange.prototype.GetAllParagraphs = function(){ return [new ApiParagraph()]; }; @@ -123,23 +111,21 @@ ApiRange.prototype.GetAllParagraphs = function(){ return [new ApiParagraph()]; } /** * Sets the selection to the specified range. * @memberof ApiRange - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiRange.prototype.Select = function(bUpdate){}; +ApiRange.prototype.Select = function(bUpdate){ return true; }; /** - * Returns a new range that goes beyond the specified range in any direction and spans a different range. The current range has not changed. Throws an error if two ranges do not have a union. + * Returns a new range that goes beyond the specified range in any direction and spans a different range. The current range has not changed. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {ApiRange} oRange - The range that will be expanded. * @returns {ApiRange | null} - returns null if the specified range can't be expanded. */ ApiRange.prototype.ExpandTo = function(oRange){ return new ApiRange(); }; /** - * Returns a new range as the intersection of the current range with another range. The current range has not changed. Throws an error if two ranges do not overlap or are not adjacent. + * Returns a new range as the intersection of the current range with another range. The current range has not changed. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {ApiRange} oRange - The range that will be intersected with the current range. * @returns {ApiRange | null} - returns null if can't intersect. */ @@ -148,7 +134,6 @@ ApiRange.prototype.IntersectWith = function(oRange){ return new ApiRange(); }; /** * Sets the bold property to the text character. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {boolean} isBold - Specifies if the Range contents are displayed bold or not. * @returns {ApiRange | null} - returns null if can't apply bold. */ @@ -157,7 +142,6 @@ ApiRange.prototype.SetBold = function(isBold){ return new ApiRange(); }; /** * Specifies that any lowercase characters in the current text Range are formatted for display only as their capital letter character equivalents. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {boolean} isCaps - Specifies if the Range contents are displayed capitalized or not. * @returns {ApiRange | null} - returns null if can't apply caps. */ @@ -166,7 +150,6 @@ ApiRange.prototype.SetCaps = function(isCaps){ return new ApiRange(); }; /** * Sets the text color to the current text Range in the RGB format. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -178,7 +161,6 @@ ApiRange.prototype.SetColor = function(r, g, b, isAuto){ return new ApiRange(); /** * Specifies that the contents of the current Range are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {boolean} isDoubleStrikeout - Specifies if the contents of the current Range are displayed double struck through or not. * @returns {ApiRange | null} - returns null if can't apply double strikeout. */ @@ -187,7 +169,6 @@ ApiRange.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return new /** * Specifies a highlighting color which is applied as a background to the contents of the current Range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiRange | null} - returns null if can't apply highlight. */ @@ -196,7 +177,6 @@ ApiRange.prototype.SetHighlight = function(sColor){ return new ApiRange(); }; /** * Specifies the shading applied to the contents of the current text Range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {ShdType} sType - The shading type applied to the contents of the current text Range. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. @@ -208,7 +188,6 @@ ApiRange.prototype.SetShd = function(sType, r, g, b){ return new ApiRange(); }; /** * Sets the italic property to the text character. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {boolean} isItalic - Specifies if the contents of the current Range are displayed italicized or not. * @returns {ApiRange | null} - returns null if can't apply italic. */ @@ -217,7 +196,6 @@ ApiRange.prototype.SetItalic = function(isItalic){ return new ApiRange(); }; /** * Specifies that the contents of the current Range are displayed with a single horizontal line through the range center. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {boolean} isStrikeout - Specifies if the contents of the current Range are displayed struck through or not. * @returns {ApiRange | null} - returns null if can't apply strikeout. */ @@ -227,7 +205,6 @@ ApiRange.prototype.SetStrikeout = function(isStrikeout){ return new ApiRange(); * Specifies that all the lowercase letter characters in the current text Range are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current Range are displayed capitalized two points smaller or not. * @returns {ApiRange | null} - returns null if can't apply small caps. */ @@ -236,7 +213,6 @@ ApiRange.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiRange(); /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiRange | null} - returns null if can't apply spacing. */ @@ -246,7 +222,6 @@ ApiRange.prototype.SetSpacing = function(nSpacing){ return new ApiRange(); }; * Specifies that the contents of the current Range are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {boolean} isUnderline - Specifies if the contents of the current Range are displayed underlined or not. * @returns {ApiRange | null} - returns null if can't apply underline. */ @@ -254,11 +229,10 @@ ApiRange.prototype.SetUnderline = function(isUnderline){ return new ApiRange(); /** * Specifies the alignment which will be applied to the Range contents in relation to the default appearance of the Range text: - * * "baseline" - the characters in the current text Range will be aligned by the default text baseline. - * * "subscript" - the characters in the current text Range will be aligned below the default text baseline. - * * "superscript" - the characters in the current text Range will be aligned above the default text baseline. + * "baseline" - the characters in the current text Range will be aligned by the default text baseline. + * "subscript" - the characters in the current text Range will be aligned below the default text baseline. + * "superscript" - the characters in the current text Range will be aligned above the default text baseline. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiRange | null} - returns null if can't apply align. */ @@ -268,7 +242,6 @@ ApiRange.prototype.SetVertAlign = function(sType){ return new ApiRange(); }; * Specifies the amount by which text is raised or lowered for the current Range in relation to the default * baseline of the surrounding non-positioned text. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {hps} nPosition - Specifies a positive (raised text) or negative (lowered text) * measurement in half-points (1/144 of an inch). * @returns {ApiRange | null} - returns null if can't set position. @@ -278,7 +251,6 @@ ApiRange.prototype.SetPosition = function(nPosition){ return new ApiRange(); }; /** * Sets the font size to the characters of the current text Range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {hps} FontSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiRange | null} - returns null if can't set font size. */ @@ -287,7 +259,6 @@ ApiRange.prototype.SetFontSize = function(FontSize){ return new ApiRange(); }; /** * Sets all 4 font slots with the specified font family. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {string} sFontFamily - The font family or families used for the current text Range. * @returns {ApiRange | null} - returns null if can't set font family. */ @@ -296,7 +267,6 @@ ApiRange.prototype.SetFontFamily = function(sFontFamily){ return new ApiRange(); /** * Sets the style to the current Range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {ApiStyle} oStyle - The style which must be applied to the text character. * @returns {ApiRange | null} - returns null if can't set style. */ @@ -305,16 +275,22 @@ ApiRange.prototype.SetStyle = function(oStyle){ return new ApiRange(); }; /** * Sets the text properties to the current Range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @param {ApiTextPr} oTextPr - The text properties that will be applied to the current range. * @returns {ApiRange | null} - returns null if can't set text properties. */ ApiRange.prototype.SetTextPr = function(oTextPr){ return new ApiRange(); }; +/** + * Returns the merged text properties of the entire range. + * @memberof ApiRange + * @returns {ApiTextPr} + * @since 8.2.0 + */ +ApiRange.prototype.GetTextPr = function(){ return new ApiTextPr(); }; + /** * Deletes all the contents from the current range. * @memberof ApiRange - * @typeofeditors ["CDE"] * @returns {boolean} - returns false if range is empty. */ ApiRange.prototype.Delete = function(){ return true; }; @@ -324,7 +300,6 @@ ApiRange.prototype.Delete = function(){ return true; }; * @memberof ApiRange * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiRange.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ return new JSON(); }; @@ -332,23 +307,107 @@ ApiRange.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ return new /** * Adds a comment to the current range. * @memberof ApiRange - * @typeofeditors ["CDE"] - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). + * @param {string} sText - The comment text. + * @param {string} [sAuthor] - The author's name. + * @param {string} [sUserId] - The user ID of the comment author. * @returns {ApiComment} - Returns null if the comment was not added. */ ApiRange.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; /** * Returns a Range object that represents the document part contained in the specified range. - * @typeofeditors ["CDE"] - * @param {Number} [Start=0] - Start character index in the current range. - * @param {Number} [End=-1] - End character index in the current range (if <= 0, then the range is taken to the end). + * @param {Number} [Start=0] - Start position index in the current range. + * @param {Number} [End=-1] - End position index in the current range (if <= 0, then the range is taken to the end). * @returns {ApiRange} - * */ + */ ApiRange.prototype.GetRange = function(nStart, nEnd){ return new ApiRange(); }; +/** + * Returns the start page number of the current range. + * @memberof ApiRange + * @returns {Number} + * @since 8.2.0 + */ +ApiRange.prototype.GetStartPage = function(){ return 0; }; + +/** + * Returns the end page number of the current range. + * @memberof ApiRange + * @returns {Number} + * @since 8.2.0 + */ +ApiRange.prototype.GetEndPage = function(){ return 0; }; + +/** + * Sets the start position of the current range object. + * @memberof ApiRange + * @param {Number} nPos - Start position. + * @returns {boolean} + * @since 8.2.0 + */ +ApiRange.prototype.SetStartPos = function(nPos){ return true; }; + +/** + * Sets the end position of the current range object. + * @memberof ApiRange + * @param {Number} nPos - End position. + * @returns {boolean} + * @since 8.2.0 + */ +ApiRange.prototype.SetEndPos = function(nPos){ return true; }; + +/** + * Returns the start position of the current range. + * @memberof ApiRange + * @returns {number} + * @since 8.2.0 + */ +ApiRange.prototype.GetStartPos = function() { return 0; }; + +/** + * Returns the start position of the current range. + * @memberof ApiRange + * @returns {number} + * @since 8.2.0 + */ +ApiRange.prototype.Start = ApiRange.prototype.GetStartPos (); + +/** + * Returns the end position of the current range. + * @memberof ApiRange + * @returns {number} + * @since 8.2.0 + */ +ApiRange.prototype.GetEndPos = function() { return 0; }; + +/** + * Returns the end position of the current range. + * @memberof ApiRange + * @returns {number} + * @since 8.2.0 + */ +ApiRange.prototype.End = ApiRange.prototype.GetEndPos (); + +/** + * Moves a cursor to a specified position of the current range object. + * If there is any selection in the document, it will be removed. + * @memberof ApiRange + * @param {number} [nPos=0] - The desired cursor position. + * @returns {boolean} + * @since 9.0.0 + */ +ApiRange.prototype.MoveCursorToPos = function(nPos){ return true; }; + +/** + * Adds a field to the specified range by the field instruction code. + * This method removes text within a range. + * @memberof ApiRange + * @param {string} sCode - The field instruction code. + * @returns {boolean} + * @since 9.0.0 + */ +ApiRange.prototype.AddField = function(sCode) { return true; }; + /** * Class representing a document. * @constructor @@ -431,7 +490,6 @@ ApiHyperlink.prototype.constructor = ApiHyperlink; /** * Returns a type of the ApiHyperlink class. * @memberof ApiHyperlink - * @typeofeditors ["CDE"] * @returns {"hyperlink"} */ ApiHyperlink.prototype.GetClassType = function(){ return ""; }; @@ -439,14 +497,12 @@ ApiHyperlink.prototype.GetClassType = function(){ return ""; }; /** * Class representing a document form base. * @constructor - * @typeofeditors ["CDE", "CFE"] */ function ApiFormBase(oSdt){} /** * Class representing a document text field. * @constructor - * @typeofeditors ["CDE", "CFE"] * @extends {ApiFormBase} */ function ApiTextForm(oSdt){} @@ -454,9 +510,8 @@ ApiTextForm.prototype = Object.create(ApiFormBase.prototype); ApiTextForm.prototype.constructor = ApiTextForm; /** - * Class representing a document combo box / dropdown list. + * Class representing a document combo box / drop-down list. * @constructor - * @typeofeditors ["CDE", "CFE"] * @extends {ApiFormBase} */ function ApiComboBoxForm(oSdt){} @@ -466,7 +521,6 @@ ApiComboBoxForm.prototype.constructor = ApiComboBoxForm; /** * Class representing a document checkbox / radio button. * @constructor - * @typeofeditors ["CDE", "CFE"] * @extends {ApiFormBase} */ function ApiCheckBoxForm(oSdt){} @@ -476,7 +530,6 @@ ApiCheckBoxForm.prototype.constructor = ApiCheckBoxForm; /** * Class representing a document picture form. * @constructor - * @typeofeditors ["CDE", "CFE"] * @extends {ApiFormBase} */ function ApiPictureForm(oSdt){} @@ -486,7 +539,6 @@ ApiPictureForm.prototype.constructor = ApiPictureForm; /** * Class representing a document date field. * @constructor - * @typeofeditors ["CDE", "CFE"] * @extends {ApiFormBase} */ function ApiDateForm(oSdt){} @@ -497,7 +549,6 @@ ApiDateForm.prototype.constructor = ApiDateForm; * Class representing a complex field. * @param oSdt * @constructor - * @typeofeditors ["CDE", "CFE"] * @extends {ApiFormBase} */ function ApiComplexForm(oSdt){} @@ -506,52 +557,45 @@ ApiComplexForm.prototype.constructor = ApiComplexForm; /** * Sets the hyperlink address. - * @typeofeditors ["CDE"] * @param {string} sLink - The hyperlink address. * @returns {boolean} - * */ + */ ApiHyperlink.prototype.SetLink = function(sLink){ return true; }; /** * Sets the hyperlink display text. - * @typeofeditors ["CDE"] * @param {string} sDisplay - The text to display the hyperlink. * @returns {boolean} - * */ + */ ApiHyperlink.prototype.SetDisplayedText = function(sDisplay){ return true; }; /** * Sets the screen tip text of the hyperlink. - * @typeofeditors ["CDE"] * @param {string} sScreenTipText - The screen tip text of the hyperlink. * @returns {boolean} - * */ + */ ApiHyperlink.prototype.SetScreenTipText = function(sScreenTipText){ return true; }; /** * Returns the hyperlink address. - * @typeofeditors ["CDE"] * @returns {string} - * */ + */ ApiHyperlink.prototype.GetLinkedText = function(){ return ""; }; /** * Returns the hyperlink display text. - * @typeofeditors ["CDE"] * @returns {string} - * */ + */ ApiHyperlink.prototype.GetDisplayedText = function(){ return ""; }; /** * Returns the screen tip text of the hyperlink. - * @typeofeditors ["CDE"] * @returns {string} - * */ + */ ApiHyperlink.prototype.GetScreenTipText = function(){ return ""; }; /** * Returns the hyperlink element using the position specified. - * @typeofeditors ["CDE"] * @param {number} nPos - The position where the element which content we want to get must be located. * @returns {ParagraphContent} */ @@ -559,32 +603,28 @@ ApiHyperlink.prototype.GetElement = function(nPos){ return new ParagraphContent( /** * Returns a number of elements in the current hyperlink. - * @typeofeditors ["CDE"] * @returns {number} */ ApiHyperlink.prototype.GetElementsCount = function(){ return 0; }; /** * Sets the default hyperlink style. - * @typeofeditors ["CDE"] * @returns {boolean} - * */ + */ ApiHyperlink.prototype.SetDefaultStyle = function(){ return true; }; /** * Returns a Range object that represents the document part contained in the specified hyperlink. - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character index in the current element. - * @param {Number} End - End character index in the current element. + * @param {Number} Start - Start position index in the current element. + * @param {Number} End - End position index in the current element. * @returns {ApiRange} - * */ + */ ApiHyperlink.prototype.GetRange = function(Start, End){ return new ApiRange(); }; /** * Converts the ApiHyperlink object into the JSON object. * @memberof ApiHyperlink * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiHyperlink.prototype.ToJSON = function(bWriteStyles){ return new JSON(); }; @@ -681,7 +721,7 @@ ApiOleObject.prototype.constructor = ApiOleObject; /** * Class representing a shape. * @constructor - * */ + */ function ApiShape(Shape){} ApiShape.prototype = Object.create(ApiDrawing.prototype); ApiShape.prototype.constructor = ApiShape; @@ -695,6 +735,21 @@ function ApiChart(Chart){} ApiChart.prototype = Object.create(ApiDrawing.prototype); ApiChart.prototype.constructor = ApiChart; +/** + * Class representing a group of drawings. + * @constructor + */ +function ApiGroup(oGroup){} +ApiGroup.prototype = Object.create(ApiDrawing.prototype); +ApiGroup.prototype.constructor = ApiGroup; + +/** + * Class representing a chart series. + * @constructor + * + */ +function ApiChartSeries(oChartSpace, nIdx){} + /** * Class representing a base class for color types. * @constructor @@ -720,7 +775,7 @@ ApiSchemeColor.prototype.constructor = ApiSchemeColor; /** * Class representing a Preset Color. * @constructor - * */ + */ function ApiPresetColor(sPresetColor){} ApiPresetColor.prototype = Object.create(ApiUniColor.prototype); ApiPresetColor.prototype.constructor = ApiPresetColor; @@ -728,7 +783,7 @@ ApiPresetColor.prototype.constructor = ApiPresetColor; /** * Class representing a base class for fill. * @constructor - * */ + */ function ApiFill(UniFill){} /** @@ -740,7 +795,7 @@ function ApiStroke(oLn){} /** * Class representing gradient stop. * @constructor - * */ + */ function ApiGradientStop(oApiUniColor, pos){} /** @@ -750,13 +805,13 @@ function ApiGradientStop(oApiUniColor, pos){} function ApiInlineLvlSdt(Sdt){} /** - * Class representing a list of values of the combo box / dropdown list content control. + * Class representing a list of values of the combo box / drop-down list content control. * @constructor */ function ApiContentControlList(Parent){} /** - * Class representing an entry of the combo box / dropdown list content control. + * Class representing an entry of the combo box / drop-down list content control. * @constructor */ function ApiContentControlListEntry(Sdt, Parent, Text, Value){} @@ -773,6 +828,18 @@ function ApiBlockLvlSdt(Sdt){} */ function ApiWatermarkSettings(oSettings){} +/** + * Class representing document properties (similar to BuiltInDocumentProperties in VBA). + * @constructor + */ +function ApiCore(oCore) {} + +/** + * Class representing custom properties of the document. + * @constructor + */ +function ApiCustomProperties(oCustomProperties) {} + /** * Twentieths of a point (equivalent to 1/1440th of an inch). * @typedef {number} twips @@ -806,12 +873,12 @@ function ApiWatermarkSettings(oSettings){} /** * 60000th of a degree (5400000 = 90 degrees). * @typedef {number} PositiveFixedAngle - * */ + */ /** * A border type which will be added to the document element. - * * "none" - no border will be added to the created element or the selected element side. - * * "single" - a single border will be added to the created element or the selected element side. + * "none" - no border will be added to the created element or the selected element side. + * "single" - a single border will be added to the created element or the selected element side. * @typedef {("none" | "single")} BorderType */ @@ -837,36 +904,36 @@ function ApiWatermarkSettings(oSettings){} /** * Header and footer types which can be applied to the document sections. - * * "default" - a header or footer which can be applied to any default page. - * * "title" - a header or footer which is applied to the title page. - * * "even" - a header or footer which can be applied to even pages to distinguish them from the odd ones (which will be considered default). + * "default" - a header or footer which can be applied to any default page. + * "title" - a header or footer which is applied to the title page. + * "even" - a header or footer which can be applied to even pages to distinguish them from the odd ones (which will be considered default). * @typedef {("default" | "title" | "even")} HdrFtrType */ /** * The possible values for the units of the width property are defined by a specific table or table cell width property. - * * "auto" - sets the table or table cell width to auto width. - * * "twips" - sets the table or table cell width to be measured in twentieths of a point. - * * "nul" - sets the table or table cell width to be of a zero value. - * * "percent" - sets the table or table cell width to be measured in percent to the parent container. + * "auto" - sets the table or table cell width to auto width. + * "twips" - sets the table or table cell width to be measured in twentieths of a point. + * "nul" - sets the table or table cell width to be of a zero value. + * "percent" - sets the table or table cell width to be measured in percent to the parent container. * @typedef {("auto" | "twips" | "nul" | "percent")} TableWidth */ /** * This simple type specifies possible values for the table sections to which the current conditional formatting properties will be applied when this selected table style is used. - * * "topLeftCell" - specifies that the table formatting is applied to the top left cell. - * * "topRightCell" - specifies that the table formatting is applied to the top right cell. - * * "bottomLeftCell" - specifies that the table formatting is applied to the bottom left cell. - * * "bottomRightCell" - specifies that the table formatting is applied to the bottom right cell. - * * "firstRow" - specifies that the table formatting is applied to the first row. - * * "lastRow" - specifies that the table formatting is applied to the last row. - * * "firstColumn" - specifies that the table formatting is applied to the first column. Any subsequent row which is in *table header* ({@link ApiTableRowPr#SetTableHeader}) will also use this conditional format. - * * "lastColumn" - specifies that the table formatting is applied to the last column. - * * "bandedColumn" - specifies that the table formatting is applied to odd numbered groupings of rows. - * * "bandedColumnEven" - specifies that the table formatting is applied to even numbered groupings of rows. - * * "bandedRow" - specifies that the table formatting is applied to odd numbered groupings of columns. - * * "bandedRowEven" - specifies that the table formatting is applied to even numbered groupings of columns. - * * "wholeTable" - specifies that the conditional formatting is applied to the whole table. + * "topLeftCell" - specifies that the table formatting is applied to the top left cell. + * "topRightCell" - specifies that the table formatting is applied to the top right cell. + * "bottomLeftCell" - specifies that the table formatting is applied to the bottom left cell. + * "bottomRightCell" - specifies that the table formatting is applied to the bottom right cell. + * "firstRow" - specifies that the table formatting is applied to the first row. + * "lastRow" - specifies that the table formatting is applied to the last row. + * "firstColumn" - specifies that the table formatting is applied to the first column. Any subsequent row which is in *table header* ({@link ApiTableRowPr#SetTableHeader}) will also use this conditional format. + * "lastColumn" - specifies that the table formatting is applied to the last column. + * "bandedColumn" - specifies that the table formatting is applied to odd numbered groupings of rows. + * "bandedColumnEven" - specifies that the table formatting is applied to even numbered groupings of rows. + * "bandedRow" - specifies that the table formatting is applied to odd numbered groupings of columns. + * "bandedRowEven" - specifies that the table formatting is applied to even numbered groupings of columns. + * "wholeTable" - specifies that the conditional formatting is applied to the whole table. * @typedef {("topLeftCell" | "topRightCell" | "bottomLeftCell" | "bottomRightCell" | "firstRow" | "lastRow" | * "firstColumn" | "lastColumn" | "bandedColumn" | "bandedColumnEven" | "bandedRow" | "bandedRowEven" | * "wholeTable")} TableStyleOverrideType @@ -913,19 +980,25 @@ function ApiWatermarkSettings(oSettings){} * "barStackedPercent3DPerspective" | "horizontalBar" | "horizontalBarStacked" | "horizontalBarStackedPercent" * | "horizontalBar3D" | "horizontalBarStacked3D" | "horizontalBarStackedPercent3D" | "lineNormal" | * "lineStacked" | "lineStackedPercent" | "line3D" | "pie" | "pie3D" | "doughnut" | "scatter" | "stock" | - * "area" | "areaStacked" | "areaStackedPercent")} ChartType + * "area" | "areaStacked" | "areaStackedPercent" | "comboBarLine" | "comboBarLineSecondary" | "comboCustom" | "unknown")} ChartType + */ + +/** + * This type specifies the type of drawing lock. + * @typedef {("noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" + * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox")} DrawingLockType */ /** * The available text vertical alignment (used to align text in a shape with a placement for text inside it). * @typedef {("top" | "center" | "bottom")} VerticalTextAlign - * */ + */ /** * The available color scheme identifiers. * @typedef {("accent1" | "accent2" | "accent3" | "accent4" | "accent5" | "accent6" | "bg1" | "bg2" | "dk1" | "dk2" * | "lt1" | "lt2" | "tx1" | "tx2")} SchemeColorId - * */ + */ /** * The available preset color names. @@ -940,23 +1013,23 @@ function ApiWatermarkSettings(oSettings){} * "dkSlateGray" | "dkSlateGrey" | "dkTurquoise" | "dkViolet" | "dodgerBlue" | "firebrick" | "floralWhite" | * "forestGreen" | "fuchsia" | "gainsboro" | "ghostWhite" | "gold" | "goldenrod" | "gray" | "green" | * "greenYellow" | "grey" | "honeydew" | "hotPink" | "indianRed" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderBlush" | "lawnGreen" | "lemonChiffon" | "lightBlue" | "lightCoral" | "lightCyan" | "lightGoldenrodYellow" | "lightGray" | "lightGreen" | "lightGrey" | "lightPink" | "lightSalmon" | "lightSeaGreen" | "lightSkyBlue" | "lightSlateGray" | "lightSlateGrey" | "lightSteelBlue" | "lightYellow" | "lime" | "limeGreen" | "linen" | "ltBlue" | "ltCoral" | "ltCyan" | "ltGoldenrodYellow" | "ltGray" | "ltGreen" | "ltGrey" | "ltPink" | "ltSalmon" | "ltSeaGreen" | "ltSkyBlue" | "ltSlateGray" | "ltSlateGrey" | "ltSteelBlue" | "ltYellow" | "magenta" | "maroon" | "medAquamarine" | "medBlue" | "mediumAquamarine" | "mediumBlue" | "mediumOrchid" | "mediumPurple" | "mediumSeaGreen" | "mediumSlateBlue" | "mediumSpringGreen" | "mediumTurquoise" | "mediumVioletRed" | "medOrchid" | "medPurple" | "medSeaGreen" | "medSlateBlue" | "medSpringGreen" | "medTurquoise" | "medVioletRed" | "midnightBlue" | "mintCream" | "mistyRose" | "moccasin" | "navajoWhite" | "navy" | "oldLace" | "olive" | "oliveDrab" | "orange" | "orangeRed" | "orchid" | "paleGoldenrod" | "paleGreen" | "paleTurquoise" | "paleVioletRed" | "papayaWhip" | "peachPuff" | "peru" | "pink" | "plum" | "powderBlue" | "purple" | "red" | "rosyBrown" | "royalBlue" | "saddleBrown" | "salmon" | "sandyBrown" | "seaGreen" | "seaShell" | "sienna" | "silver" | "skyBlue" | "slateBlue" | "slateGray" | "slateGrey" | "snow" | "springGreen" | "steelBlue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whiteSmoke" | "yellow" | "yellowGreen")} PresetColor - * */ + */ /** * Possible values for the position of chart tick labels (either horizontal or vertical). - * * "none" - not display the selected tick labels. - * * "nextTo" - sets the position of the selected tick labels next to the main label. - * * "low" - sets the position of the selected tick labels in the part of the chart with lower values. - * * "high" - sets the position of the selected tick labels in the part of the chart with higher values. + * "none" - not display the selected tick labels. + * "nextTo" - sets the position of the selected tick labels next to the main label. + * "low" - sets the position of the selected tick labels in the part of the chart with lower values. + * "high" - sets the position of the selected tick labels in the part of the chart with higher values. * @typedef {("none" | "nextTo" | "low" | "high")} TickLabelPosition - * **/ + */ /** * The type of a fill which uses an image as a background. - * * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. - * * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. + * "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface. + * "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface. * @typedef {"tile" | "stretch"} BlipFillType - * */ + */ /** * The available preset patterns which can be used for the fill. @@ -967,7 +1040,7 @@ function ApiWatermarkSettings(oSettings){} * "pct75" | "pct80" | "pct90" | "plaid" | "shingle" | "smCheck" | "smConfetti" | "smGrid" | "solidDmnd" | * "sphere" | "trellis" | "upDiag" | "vert" | "wave" | "wdDnDiag" | "wdUpDiag" | "weave" | "zigZag"} * PatternType - * */ + */ /** * @@ -983,12 +1056,12 @@ function ApiWatermarkSettings(oSettings){} * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform - * */ + */ /** * Form type. * The available form types. - * @typedef {"textForm" | "comboBoxForm" | "dropDownForm" | "checkBoxForm" | "radioButtonForm" | "pictureForm"} FormType + * @typedef {"textForm" | "comboBoxForm" | "dropDownForm" | "checkBoxForm" | "radioButtonForm" | "pictureForm" | "complexForm"} FormType */ /** @@ -1014,62 +1087,62 @@ function ApiWatermarkSettings(oSettings){} /** * Available values of the "numbered" reference type: - * * "pageNum" - the numbered item page number; - * * "paraNum" - the numbered item paragraph number; - * * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); - * * "fullCtxParaNum" - the full paragraph number, e.g. "4.1.1"; - * * "text" - the paragraph text value, e.g. if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "pageNum" - the numbered item page number; + * "paraNum" - the numbered item paragraph number; + * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); + * "fullCtxParaNum" - the full paragraph number, e.g. "4.1.1"; + * "text" - the paragraph text value, e.g. if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "text" | "aboveBelow"} numberedRefTo */ /** * Available values of the "heading" reference type: - * * "text" - the entire heading text; - * * "pageNum" - the heading page number; - * * "headingNum" - the heading sequence number; - * * "noCtxHeadingNum" - the abbreviated heading number. Make sure the cursor pointer is in the section you are referencing to, e.g. you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; - * * "fullCtxHeadingNum" - the full heading number even if the cursor pointer is in the same section; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "text" - the entire heading text; + * "pageNum" - the heading page number; + * "headingNum" - the heading sequence number; + * "noCtxHeadingNum" - the abbreviated heading number. Make sure the cursor pointer is in the section you are referencing to, e.g. you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; + * "fullCtxHeadingNum" - the full heading number even if the cursor pointer is in the same section; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"text" | "pageNum" | "headingNum" | "noCtxHeadingNum" | "fullCtxHeadingNum" | "aboveBelow"} headingRefTo */ /** * Available values of the "bookmark" reference type: - * * "text" - the entire bookmark text; - * * "pageNum" - the bookmark page number; - * * "paraNum" - the bookmark paragraph number; - * * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); - * * "fullCtxParaNum - the full paragraph number, e.g. "4.1.1"; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "text" - the entire bookmark text; + * "pageNum" - the bookmark page number; + * "paraNum" - the bookmark paragraph number; + * "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only); + * "fullCtxParaNum - the full paragraph number, e.g. "4.1.1"; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"text" | "pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "aboveBelow"} bookmarkRefTo */ /** * Available values of the "footnote" reference type: - * * "footnoteNum" - the footnote number; - * * "pageNum" - the page number of the footnote; - * * "aboveBelow" - the words "above" or "below" depending on the position of the item; - * * "formFootnoteNum" - the form number formatted as a footnote. The numbering of the actual footnotes is not affected. + * "footnoteNum" - the footnote number; + * "pageNum" - the page number of the footnote; + * "aboveBelow" - the words "above" or "below" depending on the position of the item; + * "formFootnoteNum" - the form number formatted as a footnote. The numbering of the actual footnotes is not affected. * @typedef {"footnoteNum" | "pageNum" | "aboveBelow" | "formFootnoteNum"} footnoteRefTo */ /** * Available values of the "endnote" reference type: - * * "endnoteNum" - the endnote number; - * * "pageNum" - the endnote page number; - * * "aboveBelow" - the words "above" or "below" depending on the item position; - * * "formEndnoteNum" - the form number formatted as an endnote. The numbering of the actual endnotes is not affected. + * "endnoteNum" - the endnote number; + * "pageNum" - the endnote page number; + * "aboveBelow" - the words "above" or "below" depending on the item position; + * "formEndnoteNum" - the form number formatted as an endnote. The numbering of the actual endnotes is not affected. * @typedef {"endnoteNum" | "pageNum" | "aboveBelow" | "formEndnoteNum"} endnoteRefTo */ /** * Available values of the "equation"/"figure"/"table" reference type: - * * "entireCaption"- the entire caption text; - * * "labelNumber" - the label and object number only, e.g. "Table 1.1"; - * * "captionText" - the caption text only; - * * "pageNum" - the page number containing the referenced object; - * * "aboveBelow" - the words "above" or "below" depending on the item position. + * "entireCaption"- the entire caption text; + * "labelNumber" - the label and object number only, e.g. "Table 1.1"; + * "captionText" - the caption text only; + * "pageNum" - the page number containing the referenced object; + * "aboveBelow" - the words "above" or "below" depending on the item position. * @typedef {"entireCaption" | "labelNumber" | "captionText" | "pageNum" | "aboveBelow"} captionRefTo */ @@ -1082,8 +1155,8 @@ function ApiWatermarkSettings(oSettings){} * Standard numeric format. * @typedef {("General" | "0" | "0.00" | "#,##0" | "#,##0.00" | "0%" | "0.00%" | * "0.00E+00" | "# ?/?" | "# ??/??" | "m/d/yyyy" | "d-mmm-yy" | "d-mmm" | "mmm-yy" | "h:mm AM/PM" | - * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_);(#,##0)" | "#,##0_);[Red](#,##0)" | - * "#,##0.00_);(#,##0.00)" | "#,##0.00_);[Red](#,##0.00)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat + * "h:mm:ss AM/PM" | "h:mm" | "h:mm:ss" | "m/d/yyyy h:mm" | "#,##0_\);(#,##0)" | "#,##0_\);\[Red\]\(#,##0)" | + * "#,##0.00_\);\(#,##0.00\)" | "#,##0.00_\);\[Red\]\(#,##0.00\)" | "mm:ss" | "[h]:mm:ss" | "mm:ss.0" | "##0.0E+0" | "@")} NumFormat */ /** @@ -1093,28 +1166,28 @@ function ApiWatermarkSettings(oSettings){} /** * Possible values for the caption numbering format. - * * "ALPHABETIC" - upper letter. - * * "alphabetic" - lower letter. - * * "Roman" - upper Roman. - * * "roman" - lower Roman. - * * "Arabic" - arabic. + * "ALPHABETIC" - upper letter. + * "alphabetic" - lower letter. + * "Roman" - upper Roman. + * "roman" - lower Roman. + * "Arabic" - arabic. * @typedef {("ALPHABETIC" | "alphabetic" | "Roman" | "roman" | "Arabic")} CaptionNumberingFormat - * **/ + */ /** * Possible values for the caption separator. - * * "hyphen" - the "-" punctuation mark. - * * "period" - the "." punctuation mark. - * * "colon" - the ":" punctuation mark. - * * "longDash" - the "—" punctuation mark. - * * "dash" - the "-" punctuation mark. + * "hyphen" - the "-" punctuation mark. + * "period" - the "." punctuation mark. + * "colon" - the ":" punctuation mark. + * "longDash" - the "—" punctuation mark. + * "dash" - the "-" punctuation mark. * @typedef {("hyphen" | "period" | "colon" | "longDash" | "dash")} CaptionSep - * **/ + */ /** * Possible values for the caption label. * @typedef {("Table" | "Equation" | "Figure")} CaptionLabel - * **/ + */ /** * Table of contents properties. @@ -1156,31 +1229,41 @@ function ApiWatermarkSettings(oSettings){} /** * Possible values for the table of contents leader: - * * "dot" - "......." - * * "dash" - "-------" - * * "underline" - "_______" + * "dot" - "......." + * "dash" - "-------" + * "underline" - "_______" * @typedef {("dot" | "dash" | "underline" | "none")} TocLeader - * **/ + */ /** * Possible values for the table of contents style. * @typedef {("simple" | "online" | "standard" | "modern" | "classic")} TocStyle - * **/ + */ /** * Possible values for the table of figures style. * @typedef {("simple" | "online" | "classic" | "distinctive" | "centered" | "formal")} TofStyle - * **/ + */ + +/** + * Any valid drawing element. + * @typedef {(ApiShape | ApiImage | ApiGroup | ApiOleObject | ApiChart )} Drawing + */ + +/** + * Available drawing element for grouping. + * @typedef {(ApiShape | ApiGroup | ApiImage | ApiChart)} DrawingForGroup + */ /** * The 1000th of a percent (100000 = 100%). * @typedef {number} PositivePercentage - * */ + */ /** * The type of tick mark appearance. * @typedef {("cross" | "in" | "none" | "out")} TickMark - * */ + */ /** * The watermark type. @@ -1189,13 +1272,18 @@ function ApiWatermarkSettings(oSettings){} /** * The watermark direction. - * @typedef {("horizontal" | "clockwise45" | "counterclockwise45")} WatermarkDirection + * @typedef {("horizontal" | "clockwise45" | "counterclockwise45" | "clockwise90" | "counterclockwise90")} WatermarkDirection + */ + +/** + * The Base64 image string. + * @typedef {string} Base64Img + * @example "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA..." */ /** * Returns the main document. * @memberof ApiInterface - * @typeofeditors ["CDE"] * @returns {ApiDocument} */ ApiInterface.prototype.GetDocument = function(){ return new ApiDocument(); }; @@ -1203,7 +1291,6 @@ ApiInterface.prototype.GetDocument = function(){ return new ApiDocument(); }; /** * Creates a new paragraph. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE"] * @returns {ApiParagraph} */ ApiInterface.prototype.CreateParagraph = function(){ return new ApiParagraph(); }; @@ -1212,28 +1299,25 @@ ApiInterface.prototype.CreateParagraph = function(){ return new ApiParagraph(); * Creates an element range. * If you do not specify the start and end positions, the range will be taken from the entire element. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param oElement - The element from which the range will be taken. - * @param nStart - Start range position. - * @param nEnd - End range position. - * @returns {ApiRange | null} - returns null if oElement isn't supported. + * @param element - The element from which the range will be taken. + * @param start - Start range position. + * @param end - End range position. + * @returns {ApiRange | null} - returns null if element isn't supported. */ -ApiInterface.prototype.CreateRange = function(oElement, nStart, nEnd){ return new ApiRange(); }; +ApiInterface.prototype.CreateRange = function(element, start, end){ return new ApiRange(); }; /** * Creates a new table with a specified number of rows and columns. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {number} nCols - Number of columns. - * @param {number} nRows - Number of rows. + * @param {number} cols - Number of columns. + * @param {number} rows - Number of rows. * @returns {ApiTable} */ -ApiInterface.prototype.CreateTable = function(nCols, nRows){ return new ApiTable(); }; +ApiInterface.prototype.CreateTable = function(cols, rows){ return new ApiTable(); }; /** * Creates a new smaller text block to be inserted to the current paragraph or table. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiInterface.prototype.CreateRun = function(){ return new ApiRun(); }; @@ -1241,72 +1325,75 @@ ApiInterface.prototype.CreateRun = function(){ return new ApiRun(); }; /** * Creates a new hyperlink text block to be inserted to the current paragraph or table. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {string} sLink - The hyperlink address. - * @param {string} sDisplay - The text to display the hyperlink. - * @param {string} sScreenTipText - The screen tip text. + * @param {string} link - The hyperlink address. + * @param {string} display - The text to display the hyperlink. + * @param {string} screenTipText - The screen tip text. * @returns {ApiHyperlink} */ -ApiInterface.prototype.CreateHyperlink = function(sLink, sDisplay, sScreenTipText){ return new ApiHyperlink(); }; +ApiInterface.prototype.CreateHyperlink = function(link, display, screenTipText){ return new ApiHyperlink(); }; /** * Creates an image with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently only internet URL or Base64 encoded images are supported). - * @param {EMU} nWidth - The image width in English measure units. - * @param {EMU} nHeight - The image height in English measure units. + * @param {string} imageSrc - The image source where the image to be inserted should be taken from (currently only internet URL or Base64 encoded images are supported). + * @param {EMU} width - The image width in English measure units. + * @param {EMU} height - The image height in English measure units. * @returns {ApiImage} */ -ApiInterface.prototype.CreateImage = function(sImageSrc, nWidth, nHeight){ return new ApiImage(); }; +ApiInterface.prototype.CreateImage = function(imageSrc, width, height){ return new ApiImage(); }; /** * Creates a shape with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {ShapeType} [sType="rect"] - The shape type which specifies the preset shape geometry. - * @param {EMU} [nWidth = 914400] - The shape width in English measure units. - * @param {EMU} [nHeight = 914400] - The shape height in English measure units. - * @param {ApiFill} [oFill = Api.CreateNoFill()] - The color or pattern used to fill the shape. - * @param {ApiStroke} [oStroke = Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the element shadow. + * @param {ShapeType} [shapeType="rect"] - The shape type which specifies the preset shape geometry. + * @param {EMU} [width = 914400] - The shape width in English measure units. + * @param {EMU} [height = 914400] - The shape height in English measure units. + * @param {ApiFill} [fill = Api.CreateNoFill()] - The color or pattern used to fill the shape. + * @param {ApiStroke} [stroke = Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the element shadow. * @returns {ApiShape} - * */ -ApiInterface.prototype.CreateShape = function(sType, nWidth, nHeight, oFill, oStroke){ return new ApiShape(); }; + */ +ApiInterface.prototype.CreateShape = function(shapeType, width, height, fill, stroke){ return new ApiShape(); }; + +/** + * Groups an array of drawings. + * @memberof ApiInterface + * @param {DrawingForGroup[]} drawings - An array of drawings to group. + * @returns {ApiGroup} + * @since 8.3.0 + */ +ApiInterface.prototype.CreateGroup = function(drawings){ return new ApiGroup(); }; /** * Creates a chart with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {ChartType} [sType="bar"] - The chart type used for the chart display. - * @param {Array} aSeries - The array of the data used to build the chart from. - * @param {Array} aSeriesNames - The array of the names (the source table column names) used for the data which the chart will be build from. - * @param {Array} aCatNames - The array of the names (the source table row names) used for the data which the chart will be build from. - * @param {EMU} nWidth - The chart width in English measure units. - * @param {EMU} nHeight - The chart height in English measure units. - * @param {number} nStyleIndex - The chart color style index (can be 1 - 48, as described in OOXML specification). - * @param {NumFormat[] | String[]} aNumFormats - Numeric formats which will be applied to the series (can be custom formats). + * @param {ChartType} [chartType="bar"] - The chart type used for the chart display. + * @param {number[][]} series - The array of the data used to build the chart from. + * @param {number[] | string[]} seriesNames - The array of the names (the source table column names) used for the data which the chart will be build from. + * @param {number[] | string[]} catNames - The array of the names (the source table row names) used for the data which the chart will be build from. + * @param {EMU} width - The chart width in English measure units. + * @param {EMU} height - The chart height in English measure units. + * @param {number} styleIndex - The chart color style index (can be 1 - 48, as described in OOXML specification). + * @param {NumFormat[] | String[]} numFormats - Numeric formats which will be applied to the series (can be custom formats). * The default numeric format is "General". * @returns {ApiChart} - * */ -ApiInterface.prototype.CreateChart = function(sType, aSeries, aSeriesNames, aCatNames, nWidth, nHeight, nStyleIndex, aNumFormats){ return new ApiChart(); }; + */ +ApiInterface.prototype.CreateChart = function(chartType, series, seriesNames, catNames, width, height, styleIndex, numFormats){ return new ApiChart(); }; /** * Creates an OLE object with the parameters specified. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). - * @param {EMU} nWidth - The OLE object width in English measure units. - * @param {EMU} nHeight - The OLE object height in English measure units. - * @param {string} sData - The OLE object string data. - * @param {string} sAppId - The application ID associated with the current OLE object. + * @param {string} imageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). + * @param {EMU} width - The OLE object width in English measure units. + * @param {EMU} height - The OLE object height in English measure units. + * @param {string} data - The OLE object string data. + * @param {string} appId - The application ID associated with the current OLE object. * @returns {ApiOleObject} */ -ApiInterface.prototype.CreateOleObject = function(sImageSrc, nWidth, nHeight, sData, sAppId){ return new ApiOleObject(); }; +ApiInterface.prototype.CreateOleObject = function(imageSrc, width, height, data, appId){ return new ApiOleObject(); }; /** * Creates an RGB color setting the appropriate values for the red, green and blue color components. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -1317,136 +1404,192 @@ ApiInterface.prototype.CreateRGBColor = function(r, g, b){ return new ApiRGBColo /** * Creates a complex color scheme selecting from one of the available schemes. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {SchemeColorId} sSchemeColorId - The color scheme identifier. + * @param {SchemeColorId} schemeColorId - The color scheme identifier. * @returns {ApiSchemeColor} */ -ApiInterface.prototype.CreateSchemeColor = function(sSchemeColorId){ return new ApiSchemeColor(); }; +ApiInterface.prototype.CreateSchemeColor = function(schemeColorId){ return new ApiSchemeColor(); }; /** * Creates a color selecting it from one of the available color presets. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {PresetColor} sPresetColor - A preset selected from the list of the available color preset names. + * @param {PresetColor} presetColor - A preset selected from the list of the available color preset names. * @returns {ApiPresetColor}; - * */ -ApiInterface.prototype.CreatePresetColor = function(sPresetColor){ return new ApiPresetColor(); }; + */ +ApiInterface.prototype.CreatePresetColor = function(presetColor){ return new ApiPresetColor(); }; /** * Creates a solid fill to apply to the object using a selected solid color as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiUniColor} oUniColor - The color used for the element fill. + * @param {ApiUniColor} uniColor - The color used for the element fill. * @returns {ApiFill} - * */ -ApiInterface.prototype.CreateSolidFill = function(oUniColor){ return new ApiFill(); }; + */ +ApiInterface.prototype.CreateSolidFill = function(uniColor){ return new ApiFill(); }; /** * Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} aGradientStop - The array of gradient color stops measured in 1000th of percent. - * @param {PositiveFixedAngle} Angle - The angle measured in 60000th of a degree that will define the gradient direction. + * @param {number[]} gradientStops - The array of gradient color stops measured in 1000th of percent. + * @param {PositiveFixedAngle} angle - The angle measured in 60000th of a degree that will define the gradient direction. * @returns {ApiFill} */ -ApiInterface.prototype.CreateLinearGradientFill = function(aGradientStop, Angle){ return new ApiFill(); }; +ApiInterface.prototype.CreateLinearGradientFill = function(gradientStops, angle){ return new ApiFill(); }; /** * Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} aGradientStop - The array of gradient color stops measured in 1000th of percent. + * @param {number[]} gradientStops - The array of gradient color stops measured in 1000th of percent. * @returns {ApiFill} */ -ApiInterface.prototype.CreateRadialGradientFill = function(aGradientStop){ return new ApiFill(); }; +ApiInterface.prototype.CreateRadialGradientFill = function(gradientStops){ return new ApiFill(); }; /** * Creates a pattern fill to apply to the object using the selected pattern as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {PatternType} sPatternType - The pattern type used for the fill selected from one of the available pattern types. - * @param {ApiUniColor} BgColor - The background color used for the pattern creation. - * @param {ApiUniColor} FgColor - The foreground color used for the pattern creation. + * @param {PatternType} patternType - The pattern type used for the fill selected from one of the available pattern types. + * @param {ApiUniColor} bgColor - The background color used for the pattern creation. + * @param {ApiUniColor} fgColor - The foreground color used for the pattern creation. * @returns {ApiFill} */ -ApiInterface.prototype.CreatePatternFill = function(sPatternType, BgColor, FgColor){ return new ApiFill(); }; +ApiInterface.prototype.CreatePatternFill = function(patternType, bgColor, fgColor){ return new ApiFill(); }; /** * Creates a blip fill to apply to the object using the selected image as the object background. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {string} sImageUrl - The path to the image used for the blip fill (currently only internet URL or Base64 encoded images are supported). - * @param {BlipFillType} sBlipFillType - The type of the fill used for the blip fill (tile or stretch). + * @param {string} imageUrl - The path to the image used for the blip fill (currently only internet URL or Base64 encoded images are supported). + * @param {BlipFillType} blipFillType - The type of the fill used for the blip fill (tile or stretch). * @returns {ApiFill} - * */ -ApiInterface.prototype.CreateBlipFill = function(sImageUrl, sBlipFillType){ return new ApiFill(); }; + */ +ApiInterface.prototype.CreateBlipFill = function(imageUrl, blipFillType){ return new ApiFill(); }; /** * Creates no fill and removes the fill from the element. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiFill} - * */ + */ ApiInterface.prototype.CreateNoFill = function(){ return new ApiFill(); }; /** * Creates a stroke adding shadows to the element. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {EMU} nWidth - The width of the shadow measured in English measure units. - * @param {ApiFill} oFill - The fill type used to create the shadow. + * @param {EMU} width - The width of the shadow measured in English measure units. + * @param {ApiFill} fill - The fill type used to create the shadow. * @returns {ApiStroke} - * */ -ApiInterface.prototype.CreateStroke = function(nWidth, oFill){ return new ApiStroke(); }; + */ +ApiInterface.prototype.CreateStroke = function(width, fill){ return new ApiStroke(); }; /** * Creates a gradient stop used for different types of gradients. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {ApiUniColor} oUniColor - The color used for the gradient stop. - * @param {PositivePercentage} nPos - The position of the gradient stop measured in 1000th of percent. + * @param {ApiUniColor} uniColor - The color used for the gradient stop. + * @param {PositivePercentage} pos - The position of the gradient stop measured in 1000th of percent. * @returns {ApiGradientStop} - * */ -ApiInterface.prototype.CreateGradientStop = function(oUniColor, nPos){ return new ApiGradientStop(); }; + */ +ApiInterface.prototype.CreateGradientStop = function(uniColor, pos){ return new ApiGradientStop(); }; /** * Creates a new inline container. * @memberof ApiInterface - * @typeofeditors ["CDE"] * @returns {ApiInlineLvlSdt} */ ApiInterface.prototype.CreateInlineLvlSdt = function(){ return new ApiInlineLvlSdt(); }; +/** + * The checkbox content control properties + * @typedef {Object} ContentControlCheckBoxPr + * @property {boolean} [checked] Indicates whether the checkbox is checked by default. + * @property {string} [checkedSymbol] A custom symbol to display when the checkbox is checked (e.g., "в�’"). + * @property {string} [uncheckedSymbol] A custom symbol to display when the checkbox is unchecked (e.g., "в�ђ"). + */ + +/** + * Creates a checkbox content control. + * @memberof ApiInterface + * @since 9.0.0 + * @param {ContentControlCheckBoxPr} checkBoxPr The configuration object with the checkbox properties. + * @returns {ApiInlineLvlSdt} An inline-level content control that represents a checkbox. + */ +ApiInterface.prototype.CreateCheckBoxContentControl = function(checkBoxPr){ return new ApiInlineLvlSdt(); }; + +/** + * Creates a new picture container. + * @memberof ApiInterface + * @since 9.0.0 + * @param {EMU} [width] - The optional image width. + * @param {EMU} [height] - The optional image height. + * @returns {ApiInlineLvlSdt} An inline-level content control that represents a picture container. + */ +ApiInterface.prototype.CreatePictureContentControl = function(width, height){ return new ApiInlineLvlSdt(); }; + +/** + * The object representing the items in the combo box or drop-down list. + * @typedef {Object} ContentControlListItem + * @property {string} display - The text to be displayed in the combo box or drop-down list. + * @property {string} value - The value associated with the item. + */ + +/** + * Creates a new combo box container with the given list of options. + * @memberof ApiInterface + * @since 9.0.0 + * @param {ContentControlListItem[]} [list] - An array of objects representing the items in the combo box. + * @param {number} [selected=-1] - The selected item index. + * @returns {ApiInlineLvlSdt} An inline-level content control that represents a combo box. + */ +ApiInterface.prototype.CreateComboBoxContentControl = function(list, selected){ return new ApiInlineLvlSdt(); }; + +/** + * Creates a new drop-down list container with the given list of options. + * @memberof ApiInterface + * @since 9.0.0 + * @param {ContentControlListItem[]} [list] - An array of objects representing the items in the drop-down list. + * @param {number} [selected=-1] - The selected item index. + * @returns {ApiInlineLvlSdt} An inline-level content control that represents a drop-down list. + */ +ApiInterface.prototype.CreateDropDownListContentControl = function(list, selected){ return new ApiInlineLvlSdt(); }; + +/** + * The date picker content control properties. + * @typedef {Object} ContentControlDatePr + * @property {string} format - The date format. Example: "mm.dd.yyyy". + * @property {string} lang - The date language. Possible value for this parameter is a language identifier as defined by + * RFC 4646/BCP 47. Example: "en-CA". + */ + +/** + * Creates a new date picker content control. + * @memberof ApiInterface + * @since 9.0.0 + * @param {ContentControlDatePr} [datePickerPr] - The optional date picker properties. + * @returns {ApiInlineLvlSdt} An inline-level content control that represents a date-time picker. + */ +ApiInterface.prototype.CreateDatePickerContentControl = function(datePickerPr){ return new ApiInlineLvlSdt(); }; + /** * Creates a new block level container. * @memberof ApiInterface - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt} */ ApiInterface.prototype.CreateBlockLvlSdt = function(){ return new ApiBlockLvlSdt(); }; /** * Saves changes to the specified document. - * @typeofeditors ["CDE"] * @memberof ApiInterface + * @returns {boolean} */ -ApiInterface.prototype.Save = function () {}; +ApiInterface.prototype.Save = function(){ return true; }; /** * Loads data for the mail merge. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {String[][]} aList - Mail merge data. The first element of the array is the array with names of the merge fields. + * @param {String[][]} data - Mail merge data. The first element of the array is the array with names of the merge fields. * The rest of the array elements are arrays with values for the merge fields. - * @typeofeditors ["CDE"] * @returns {boolean} */ -ApiInterface.prototype.LoadMailMergeData = function(aList){ return true; }; +ApiInterface.prototype.LoadMailMergeData = function(data){ return true; }; /** * Returns the mail merge template document. * @memberof ApiInterface - * @typeofeditors ["CDE"] * @returns {ApiDocumentContent} */ ApiInterface.prototype.GetMailMergeTemplateDocContent = function(){ return new ApiDocumentContent(); }; @@ -1454,7 +1597,6 @@ ApiInterface.prototype.GetMailMergeTemplateDocContent = function(){ return new A /** * Returns the mail merge receptions count. * @memberof ApiInterface - * @typeofeditors ["CDE"] * @returns {number} */ ApiInterface.prototype.GetMailMergeReceptionsCount = function(){ return 0; }; @@ -1462,32 +1604,30 @@ ApiInterface.prototype.GetMailMergeReceptionsCount = function(){ return 0; }; /** * Replaces the main document content with another document content. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {ApiDocumentContent} oApiDocumentContent - The document content which the main document content will be replaced with. + * @param {ApiDocumentContent} documentContent - The document content which the main document content will be replaced with. + * @returns {boolean} */ -ApiInterface.prototype.ReplaceDocumentContent = function(oApiDocumentContent){}; +ApiInterface.prototype.ReplaceDocumentContent = function(documentContent){ return true; }; /** * Starts the mail merge process. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {number} [nStartIndex=0] - The start index of the document for mail merge process. - * @param {number} [nEndIndex=Api.GetMailMergeReceptionsCount() - 1] - The end index of the document for mail merge process. + * @param {number} [startIndex=0] - The start index of the document for mail merge process. + * @param {number} [endIndex=Api.GetMailMergeReceptionsCount() - 1] - The end index of the document for mail merge process. * @returns {boolean} */ -ApiInterface.prototype.MailMerge = function(nStartIndex, nEndIndex){ return true; }; +ApiInterface.prototype.MailMerge = function(startIndex, endIndex){ return true; }; /** * Converts the specified JSON object into the Document Builder object of the corresponding type. * @memberof ApiInterface - * @param {JSON} sMessage - The JSON object to convert. - * @typeofeditors ["CDE"] + * @param {JSON} message - The JSON object to convert. + * @returns {object} - readed api class element */ -ApiInterface.prototype.FromJSON = function(sMessage){}; +ApiInterface.prototype.FromJSON = function(message){ return new object(); }; /** * Returns a type of the ApiUnsupported class. - * @typeofeditors ["CDE"] * @returns {"unsupported"} */ ApiUnsupported.prototype.GetClassType = function(){ return ""; }; @@ -1495,38 +1635,36 @@ ApiUnsupported.prototype.GetClassType = function(){ return ""; }; /** * Adds a comment to the specifed document element or array of Runs. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {ApiRun[] | DocumentElement} oElement - The element where the comment will be added. It may be applied to any element which has the *AddComment* method. - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). + * @param {ApiRun[] | DocumentElement} element - The element where the comment will be added. It may be applied to any element which has the *AddComment* method. + * @param {string} text - The comment text. + * @param {string} [author] - The author's name. + * @param {string} [userId] - The user ID of the comment author. * @returns {ApiComment} - Returns null if the comment was not added. */ -ApiInterface.prototype.AddComment = function(oElement, sText, sAuthor, sUserId){ return new ApiComment(); }; +ApiInterface.prototype.AddComment = function(element, text, author, userId){ return new ApiComment(); }; /** * Subscribes to the specified event and calls the callback function when the event fires. * @function * @memberof ApiInterface - * @typeofeditors ["CDE"] * @param {string} eventName - The event name. * @param {function} callback - Function to be called when the event fires. + * @returns {boolean} */ -ApiInterface.prototype["attachEvent"] = ApiInterface.prototype.attachEvent;{}; +ApiInterface.prototype["attachEvent"] = ApiInterface.prototype.attachEvent;{ return true; }; /** * Unsubscribes from the specified event. * @function * @memberof ApiInterface - * @typeofeditors ["CDE"] * @param {string} eventName - The event name. + * @returns {boolean} */ -ApiInterface.prototype["detachEvent"] = ApiInterface.prototype.detachEvent;{}; +ApiInterface.prototype["detachEvent"] = ApiInterface.prototype.detachEvent;{ return true; }; /** * Returns a type of the ApiDocumentContent class. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"documentContent"} */ ApiDocumentContent.prototype.GetClassType = function(){ return ""; }; @@ -1534,7 +1672,6 @@ ApiDocumentContent.prototype.GetClassType = function(){ return ""; }; /** * Returns a number of elements in the current document. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {number} */ ApiDocumentContent.prototype.GetElementsCount = function(){ return 0; }; @@ -1543,7 +1680,6 @@ ApiDocumentContent.prototype.GetElementsCount = function(){ return 0; }; * Returns an element by its position in the document. * @memberof ApiDocumentContent * @param {number} nPos - The element position that will be taken from the document. - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {DocumentElement} */ ApiDocumentContent.prototype.GetElement = function(nPos){ return new DocumentElement(); }; @@ -1551,16 +1687,15 @@ ApiDocumentContent.prototype.GetElement = function(nPos){ return new DocumentEle /** * Adds a paragraph or a table or a blockLvl content control using its position in the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The position where the current element will be added. * @param {DocumentElement} oElement - The document element which will be added at the current position. + * @returns {boolean} */ -ApiDocumentContent.prototype.AddElement = function(nPos, oElement){}; +ApiDocumentContent.prototype.AddElement = function(nPos, oElement){ return true; }; /** * Pushes a paragraph or a table to actually add it to the document. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {DocumentElement} oElement - The element type which will be pushed to the document. * @returns {boolean} - returns false if oElement is unsupported. */ @@ -1571,59 +1706,54 @@ ApiDocumentContent.prototype.Push = function(oElement){ return true; }; * When all elements are removed, a new empty paragraph is automatically created. If you want to add * content to this paragraph, use the {@link ApiDocumentContent#GetElement} method. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiDocumentContent.prototype.RemoveAllElements = function(){}; +ApiDocumentContent.prototype.RemoveAllElements = function(){ return true; }; /** * Removes an element using the position specified. * @memberof ApiDocumentContent - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The element number (position) in the document or inside other element. + * @returns {boolean} */ -ApiDocumentContent.prototype.RemoveElement = function(nPos){}; +ApiDocumentContent.prototype.RemoveElement = function(nPos){ return true; }; /** * Returns a Range object that represents the part of the document contained in the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character in the current element. - * @param {Number} End - End character in the current element. + * @param {Number} Start - Start position index in the current element. + * @param {Number} End - End position index in the current element. * @returns {ApiRange} - * */ + */ ApiDocumentContent.prototype.GetRange = function(Start, End){ return new ApiRange(); }; /** * Converts the ApiDocumentContent object into the JSON object. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] - * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. - * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. + * @param {boolean} isWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. + * @param {boolean} isWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} */ -ApiDocumentContent.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ return new JSON(); }; +ApiDocumentContent.prototype.ToJSON = function(isWriteNumberings, isWriteStyles){ return new JSON(); }; /** * Returns an array of document elements from the current ApiDocumentContent object. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] * @param {boolean} bGetCopies - Specifies if the copies of the document elements will be returned or not. - * @returns {Array} + * @returns {DocumentElement[]} */ -ApiDocumentContent.prototype.GetContent = function(bGetCopies){ return []; }; +ApiDocumentContent.prototype.GetContent = function(bGetCopies){ return [new DocumentElement()]; }; /** * Returns a collection of drawing objects from the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] - * @returns {ApiDrawing[]} + * @returns {Drawing[]} */ -ApiDocumentContent.prototype.GetAllDrawingObjects = function(){ return [new ApiDrawing()]; }; +ApiDocumentContent.prototype.GetAllDrawingObjects = function(){ return [new Drawing()]; }; /** * Returns a collection of shape objects from the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] * @returns {ApiShape[]} */ ApiDocumentContent.prototype.GetAllShapes = function(){ return [new ApiShape()]; }; @@ -1631,7 +1761,6 @@ ApiDocumentContent.prototype.GetAllShapes = function(){ return [new ApiShape()]; /** * Returns a collection of image objects from the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] * @returns {ApiImage[]} */ ApiDocumentContent.prototype.GetAllImages = function(){ return [new ApiImage()]; }; @@ -1639,7 +1768,6 @@ ApiDocumentContent.prototype.GetAllImages = function(){ return [new ApiImage()]; /** * Returns a collection of chart objects from the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] * @returns {ApiChart[]} */ ApiDocumentContent.prototype.GetAllCharts = function(){ return [new ApiChart()]; }; @@ -1647,7 +1775,6 @@ ApiDocumentContent.prototype.GetAllCharts = function(){ return [new ApiChart()]; /** * Returns a collection of OLE objects from the document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] * @returns {ApiOleObject[]} */ ApiDocumentContent.prototype.GetAllOleObjects = function(){ return [new ApiOleObject()]; }; @@ -1655,7 +1782,6 @@ ApiDocumentContent.prototype.GetAllOleObjects = function(){ return [new ApiOleOb /** * Returns an array of all paragraphs from the current document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] * @returns {ApiParagraph[]} */ ApiDocumentContent.prototype.GetAllParagraphs = function(){ return [new ApiParagraph()]; }; @@ -1663,15 +1789,412 @@ ApiDocumentContent.prototype.GetAllParagraphs = function(){ return [new ApiParag /** * Returns an array of all tables from the current document content. * @memberof ApiDocumentContent - * @typeofeditors ["CDE"] - * @returns {ApiParagraph[]} + * @returns {ApiTable[]} */ -ApiDocumentContent.prototype.GetAllTables = function(){ return [new ApiParagraph()]; }; +ApiDocumentContent.prototype.GetAllTables = function(){ return [new ApiTable()]; }; + +/** + * Returns the inner text of the current document content object. + * @memberof ApiDocumentContent + * @param {object} oProps - The resulting string display properties. + * @param {boolean} oProps.Numbering - Defines if the resulting string will include numbering or not. + * @param {boolean} oProps.Math - Defines if the resulting string will include mathematical expressions or not. + * @param {string} [oProps.TableCellSeparator='\t'] - Defines how the table cell separator will be specified in the resulting string. Any symbol can be used. The default separator is "\t". + * @param {string} [oProps.TableRowSeparator='\r\n'] - Defines how the table row separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r\n". + * @param {string} [oProps.ParaSeparator='\r\n'] - Defines how the paragraph separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r\n". + * @param {string} [oProps.TabSymbol='\t'] - Defines how the tab will be specified in the resulting string. Any symbol can be used. The default symbol is "\t". + * @param {string} [oProps.NewLineSeparator='\r'] - Defines how the line separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r". + * @returns {string} + * @since 8.3.0 + */ +ApiDocumentContent.prototype.GetText = function(oProps){ return ""; }; + +/** + * Returns the current paragraph where the cursor is located. + * @memberof ApiDocumentContent + * @returns {ApiParagraph} + * @since 9.0.0 + */ +ApiDocumentContent.prototype.GetCurrentParagraph = function(){ return new ApiParagraph(); }; + +/** + * Returns the current run where the cursor is located. + * @memberof ApiDocumentContent + * @returns {ApiRun} + * @since 9.0.0 + */ +ApiDocumentContent.prototype.GetCurrentRun = function(){ return new ApiRun(); }; + +/** + * Returns the currently selected content control. + * @memberof ApiDocumentContent + * @since 9.0.0 + * @returns {ApiBlockLvlSdt | ApiInlineLvlSdt | null} + */ +ApiDocumentContent.prototype.GetCurrentContentControl = function(){ return new ApiBlockLvlSdt(); }; + +/** + * Class representing a custom XML manager, which provides methods to manage custom XML parts in the document. + * @param doc - The current document. + * @constructor + */ +function ApiCustomXmlParts(doc){} +ApiCustomXmlParts.prototype = Object.create(ApiCustomXmlParts.prototype); +ApiCustomXmlParts.prototype.constructor = ApiCustomXmlParts; + +/** + * Adds a new custom XML part to the XML manager. + * @memberof ApiCustomXmlParts + * @since 9.0.0 + * @param {string} xml - The XML string to be added. + * @returns {ApiCustomXmlPart} The newly created ApiCustomXmlPart object. + */ +ApiCustomXmlParts.prototype.Add = function(xml){ return new ApiCustomXmlPart(); }; + +/** + * Returns a type of the ApiCustomXmlParts class. + * @memberof ApiCustomXmlParts + * @returns {"customXmlParts"} + */ +ApiCustomXmlParts.prototype.GetClassType = function(){ return ""; }; + +/** + * Returns a custom XML part by its ID from the XML manager. + * @memberof ApiCustomXmlParts + * @since 9.0.0 + * @param {string} xmlPartId - The XML part ID. + * @returns {ApiCustomXmlPart|null} The corresponding ApiCustomXmlPart object if found, or null if no match is found. + */ +ApiCustomXmlParts.prototype.GetById = function(xmlPartId){ return new ApiCustomXmlPart(); }; + +/** + * Returns custom XML parts by namespace from the XML manager. + * @memberof ApiCustomXmlParts + * @since 9.0.0 + * @param {string} namespace - The namespace of the XML parts. + * @returns {ApiCustomXmlPart[]} An array of ApiCustomXmlPart objects or null if no matching XML parts are found. + */ +ApiCustomXmlParts.prototype.GetByNamespace = function(namespace){ return [new ApiCustomXmlPart()]; }; + +/** + * Returns a number of custom XML parts in the XML manager. + * @memberof ApiCustomXmlParts + * @since 9.0.0 + * @returns {number} The number of custom XML parts. + */ +ApiCustomXmlParts.prototype.GetCount = function(){ return 0; }; + +/** + * Returns all custom XML parts from the XML manager. + * @memberof ApiCustomXmlParts + * @since 9.0.0 + * @returns {ApiCustomXmlPart[]} An array of all custom XML parts. + */ +ApiCustomXmlParts.prototype.GetAll = function(){ return [new ApiCustomXmlPart()]; }; + +/** + * Class representing a custom XML part. + * @constructor + * @since 9.0.0 + * @param {Object} customXMl - The custom XML object. + * @param {Object} customXmlManager - The custom XML manager instance. + * @memberof ApiCustomXmlPart + */ +function ApiCustomXmlPart(customXMl, customXmlManager){} +ApiCustomXmlPart.prototype = Object.create(ApiCustomXmlPart.prototype); +ApiCustomXmlPart.prototype.constructor = ApiCustomXmlPart; + +/** + * Returns a type of the ApiCustomXmlPart class. + * @memberof ApiCustomXmlPart + * @returns {"customXmlPart"} + */ +ApiCustomXmlPart.prototype.GetClassType = function(){ return ""; }; + +/** + * Returns the ID of the custom XML part. + * @memberof ApiCustomXmlPart + * @returns {string} + */ +ApiCustomXmlPart.prototype.GetId = function(){ return ""; }; + +/** + * Retrieves nodes from custom XML based on the provided XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath expression to search for nodes. + * @returns {ApiCustomXmlNode[]} An array of ApiCustomXmlNode objects corresponding to the found nodes. + */ +ApiCustomXmlPart.prototype.GetNodes = function(xPath){ return [new ApiCustomXmlNode()]; }; + +/** + * Retrieves the XML string from the custom XML part. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @returns {string} The XML string. + */ +ApiCustomXmlPart.prototype.GetXml = function(){ return ""; }; + +/** + * Deletes the XML from the custom XML manager. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @returns {boolean} True if the XML was successfully deleted. + */ +ApiCustomXmlPart.prototype.Delete = function(){ return true; }; + +/** + * Deletes an attribute from the XML node at the specified XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath of the node from which to delete the attribute. + * @param {string} name - The name of the attribute to delete. + * @returns {boolean} True if the attribute was successfully deleted. + */ +ApiCustomXmlPart.prototype.DeleteAttribute = function(xPath, name){ return true; }; + +/** + * Inserts an attribute into the XML node at the specified XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath of the node to insert the attribute into. + * @param {string} name - The name of the attribute to insert. + * @param {string} value - The value of the attribute to insert. + * @returns {boolean} True if the attribute was successfully inserted. + */ +ApiCustomXmlPart.prototype.InsertAttribute = function(xPath, name, value){ return true; }; + +/** + * Returns an attribute from the XML node at the specified XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath of the node from which to get the attribute. + * @param {string} name - The name of the attribute to find. + * @returns {string | null} The attribute value or null if no matching attributes are found. + */ +ApiCustomXmlPart.prototype.GetAttribute = function(xPath, name){ return ""; }; + +/** + * Updates an attribute of the XML node at the specified XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath of the node whose attribute should be updated. + * @param {string} name - The name of the attribute to update. + * @param {string} value - The new value for the attribute. + * @returns {boolean} True if the attribute was successfully updated. + */ +ApiCustomXmlPart.prototype.UpdateAttribute = function(xPath, name, value){ return true; }; + +/** + * Deletes an XML element at the specified XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath of the node to delete. + * @returns {boolean} True if the element was successfully deleted. + */ +ApiCustomXmlPart.prototype.DeleteElement = function(xPath){ return true; }; + +/** + * Inserts an XML element at the specified XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath of the parent node where the new element will be inserted. + * @param {string} xmlStr - The XML string to insert. + * @param {number} [index] - The position at which to insert the new XML element. If omitted, the element will be appended as the last child. + * @returns {boolean} True if the insertion was successful. + */ +ApiCustomXmlPart.prototype.InsertElement = function(xPath, xmlStr, index){ return true; }; + +/** + * Updates an XML element at the specified XPath. + * @memberof ApiCustomXmlPart + * @since 9.0.0 + * @param {string} xPath - The XPath of the node to update. + * @param {string} xmlStr - The XML string to replace the node content with. + * @returns {boolean} True if the update was successful. + */ +ApiCustomXmlPart.prototype.UpdateElement = function(xPath, xmlStr){ return true; }; + +/** + * Class representing a custom XML node. + * @constructor + * @since 9.0.0 + * @param xmlNode - The custom XML node. + * @param xmlPart - The custom XML part. + */ +function ApiCustomXmlNode(xmlNode, xmlPart){} +ApiCustomXmlNode.prototype = Object.create(ApiCustomXmlNode.prototype); +ApiCustomXmlNode.prototype.constructor = ApiCustomXmlNode; + +/** + * Returns a type of the ApiCustomXmlNode class. + * @memberof ApiCustomXmlNode + * @returns {"customXmlNode"} + */ +ApiCustomXmlNode.prototype.GetClassType = function(){ return ""; }; + +/** + * Returns nodes from the custom XML node based on the given XPath. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} xPath - The XPath expression to match nodes. + * @returns {ApiCustomXmlNode[]} An array of nodes that match the given XPath. + */ +ApiCustomXmlNode.prototype.GetNodes = function(xPath){ return [new ApiCustomXmlNode()]; }; + +/** + * Returns the absolute XPath of the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {string} The absolute XPath of the current node. + */ +ApiCustomXmlNode.prototype.GetXPath = function(){ return ""; }; + +/** + * Returns the name of the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {string} The name of the current node. + */ +ApiCustomXmlNode.prototype.GetNodeName = function(){ return ""; }; + +/** + * Returns the XML string representation of the current node content. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {string} The XML string representation of the current node content. + */ +ApiCustomXmlNode.prototype.GetNodeValue = function(){ return ""; }; + +/** + * Returns the XML string of the current node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {string} The XML string representation of the current node. + */ +ApiCustomXmlNode.prototype.GetXml = function(){ return ""; }; + +/** + * Returns the inner text of the current node and its child nodes. + * For example: `1234` returns `"1234"`. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {string} The combined text content of the node and its descendants. + */ +ApiCustomXmlNode.prototype.GetText = function(){ return ""; }; + +/** + * Sets the XML content for the current node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} xml - The XML string to set as the content of the current node. + * @returns {boolean} Returns `true` if the XML was successfully set. + */ +ApiCustomXmlNode.prototype.SetNodeValue = function(xml){ return true; }; + +/** + * Sets the text content of the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} str - The text content to set for the node. + * @returns {boolean} Returns `true` if the text was successfully set. + */ +ApiCustomXmlNode.prototype.SetText = function(str){ return true; }; + +/** + * Sets the XML content of the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} strXml - The XML string to set as the node content. + * @returns {boolean} Returns `true` if the XML was successfully set. + */ +ApiCustomXmlNode.prototype.SetXml = function(strXml){ return true; }; + +/** + * Deletes the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {boolean} Returns `true` if the node was successfully deleted. + */ +ApiCustomXmlNode.prototype.Delete = function(){ return true; }; + +/** + * Returns the parent of the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {ApiCustomXmlNode | null} The parent node, or `null` if the current node has no parent. + */ +ApiCustomXmlNode.prototype.GetParent = function(){ return new ApiCustomXmlNode(); }; + +/** + * Creates a child node for the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} nodeName - The name of the new child node. + * @returns {ApiCustomXmlNode} The newly created child node. + */ +ApiCustomXmlNode.prototype.Add = function(nodeName){ return new ApiCustomXmlNode(); }; + +/** + * Represents an attribute of an XML node. + * @typedef {Object} CustomXmlNodeAttribute + * @property {string} name - The attribute name. + * @property {string} value - The attribute value. + */ + +/** + * Returns a list of attributes of the current XML node. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @returns {CustomXmlNodeAttribute[]} An array of attribute objects. + */ +ApiCustomXmlNode.prototype.GetAttributes = function(){ return [new CustomXmlNodeAttribute()]; }; + +/** + * Sets an attribute for the custom XML node. + * If the attribute already exists, it will not be modified. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} name - The name of the attribute to set. + * @param {string} value - The value to assign to the attribute. + * @returns {boolean} Returns `true` if the attribute was successfully set, `false` if the attribute already exists. + */ +ApiCustomXmlNode.prototype.SetAttribute = function(name, value){ return true; }; + +/** + * Updates the value of an existing attribute in the custom XML node. + * If the attribute doesn't exist, the update will not occur. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} name - The name of the attribute to update. + * @param {string} value - The new value to assign to the attribute. + * @returns {boolean} Returns `true` if the attribute was successfully updated, `false` if the attribute doesn't exist. + */ +ApiCustomXmlNode.prototype.UpdateAttribute = function(name, value){ return true; }; + +/** + * Deletes an attribute from the custom XML node. + * If the attribute exists, it will be removed. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} name - The name of the attribute to delete. + * @returns {boolean} Returns `true` if the attribute was successfully deleted, `false` if the attribute didn't exist. + */ +ApiCustomXmlNode.prototype.DeleteAttribute = function(name){ return true; }; + +/** + * Retrieves the attribute value from the custom XML node. + * If the attribute doesn't exist, it returns `false`. + * @memberof ApiCustomXmlNode + * @since 9.0.0 + * @param {string} name - The name of the attribute to retrieve. + * @returns {string |null} The value of the attribute if it exists, or `null` if the attribute is not found. + */ +ApiCustomXmlNode.prototype.GetAttribute = function(name){ return ""; }; /** * Returns a type of the ApiDocument class. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {"document"} */ ApiDocument.prototype.GetClassType = function(){ return ""; }; @@ -1679,13 +2202,13 @@ ApiDocument.prototype.GetClassType = function(){ return ""; }; /** * Creates a new history point. * @memberof ApiDocument + * @returns {boolean} */ -ApiDocument.prototype.CreateNewHistoryPoint = function(){}; +ApiDocument.prototype.CreateNewHistoryPoint = function(){ return true; }; /** * Returns a style by its name. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {string} sStyleName - The style name. * @returns {ApiStyle} */ @@ -1694,7 +2217,6 @@ ApiDocument.prototype.GetStyle = function(sStyleName){ return new ApiStyle(); }; /** * Creates a new style with the specified type and name. If there is a style with the same name it will be replaced with a new one. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {string} sStyleName - The name of the style which will be created. * @param {StyleType} [sType="paragraph"] - The document element which the style will be applied to. * @returns {ApiStyle} @@ -1704,7 +2226,6 @@ ApiDocument.prototype.CreateStyle = function(sStyleName, sType){ return new ApiS /** * Returns the default style parameters for the specified document element. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {StyleType} sStyleType - The document element which we want to get the style for. * @returns {ApiStyle} */ @@ -1713,7 +2234,6 @@ ApiDocument.prototype.GetDefaultStyle = function(sStyleType){ return new ApiStyl /** * Returns a set of default properties for the text run in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiTextPr} */ ApiDocument.prototype.GetDefaultTextPr = function(){ return new ApiTextPr(); }; @@ -1721,7 +2241,6 @@ ApiDocument.prototype.GetDefaultTextPr = function(){ return new ApiTextPr(); }; /** * Returns a set of default paragraph properties in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiParaPr} */ ApiDocument.prototype.GetDefaultParaPr = function(){ return new ApiParaPr(); }; @@ -1729,7 +2248,6 @@ ApiDocument.prototype.GetDefaultParaPr = function(){ return new ApiParaPr(); }; /** * Returns the document final section. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiSection} */ ApiDocument.prototype.GetFinalSection = function(){ return new ApiSection(); }; @@ -1738,7 +2256,6 @@ ApiDocument.prototype.GetFinalSection = function(){ return new ApiSection(); }; * Creates a new document section which ends at the specified paragraph. Allows to set local parameters to the current * section - page size, footer, header, columns, etc. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {ApiParagraph} oParagraph - The paragraph after which a new document section will be inserted. * Paragraph must be in a document. * @returns {ApiSection | null} Returns null if parametr is invalid. @@ -1749,15 +2266,14 @@ ApiDocument.prototype.CreateSection = function(oParagraph){ return new ApiSectio * Specifies whether sections in this document will have different headers and footers for even and * odd pages (one header/footer for odd pages and another header/footer for even pages). * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {boolean} isEvenAndOdd - If true the header/footer will be different for odd and even pages, if false they will be the same. + * @returns {boolean} */ -ApiDocument.prototype.SetEvenAndOddHdrFtr = function(isEvenAndOdd){}; +ApiDocument.prototype.SetEvenAndOddHdrFtr = function(isEvenAndOdd){ return true; }; /** * Creates an abstract multilevel numbering with a specified type. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {("bullet" | "numbered")} [sType="bullet"] - The type of the numbering which will be created. * @returns {ApiNumbering} */ @@ -1766,7 +2282,6 @@ ApiDocument.prototype.CreateNumbering = function(sType){ return new ApiNumbering /** * Inserts an array of elements into the current position of the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {DocumentElement[]} arrContent - An array of elements to insert. * @param {boolean} [isInline=false] - Inline insert or not (works only for the last and the first element and only if it's a paragraph). * @param {object} [oPr=undefined] - Specifies that text and paragraph document properties are preserved for the inserted elements. @@ -1776,33 +2291,45 @@ ApiDocument.prototype.CreateNumbering = function(sType){ return new ApiNumbering ApiDocument.prototype.InsertContent = function(arrContent, isInline, oPr){ return true; }; /** - * Record of one comment. + * Represents a single comment record. * @typedef {Object} CommentReportRecord - * @property {boolean} [IsAnswer=false] - Specifies whether this is an initial comment or a reply to another comment. - * @property {string} CommentMessage - The text of the current comment. - * @property {number} Date - The time when this change was made in local time. - * @property {number} DateUTC - The time when this change was made in UTC. - * @property {string} [QuoteText=undefined] - The text to which this comment is related. + * @property {boolean} IsAnswer Specifies whether the comment is a response. + * @property {string} CommentMessage The comment text. + * @property {number} Date The comment local timestamp. + * @property {number} DateUTC The comment UTC timestamp. + * @property {string} [QuoteText] The quoted text (if available). */ /** - * Report on all comments. - * This is a dictionary where the keys are usernames. - * @typedef {Object.>} CommentReport + * Represents a user's comment history. + * @typedef {Object} UserComments + * @property {CommentReportRecord[]} comments A list of comments. + */ + +/** + * A dictionary of users and their comments. + * @typedef {Object} CommentReport + * @property {UserComments} [username] The comments grouped by username. * @example - * { - * "John Smith" : [{IsAnswer: false, CommentMessage: 'Good text', Date: 1688588002698, DateUTC: 1688570002698, QuoteText: 'Some text'}, - * {IsAnswer: true, CommentMessage: "I don't think so", Date: 1688588012661, DateUTC: 1688570012661}], - * - * "Mark Pottato" : [{IsAnswer: false, CommentMessage: 'Need to change this part', Date: 1688587967245, DateUTC: 1688569967245, QuoteText: 'The quick brown fox jumps over the lazy dog'}, - * {IsAnswer: false, CommentMessage: 'We need to add a link', Date: 1688587967245, DateUTC: 1688569967245, QuoteText: 'OnlyOffice'}] - * } + * { + * "John Smith": { + * comments: [ + * { IsAnswer: false, CommentMessage: "Good text", Date: 1688588002698, DateUTC: 1688570002698, QuoteText: "Some text" }, + * { IsAnswer: true, CommentMessage: "I don't think so", Date: 1688588012661, DateUTC: 1688570012661 } + * ] + * }, + * "Mark Pottato": { + * comments: [ + * { IsAnswer: false, CommentMessage: "Need to change this part", Date: 1688587967245, DateUTC: 1688569967245, QuoteText: "The quick brown fox jumps over the lazy dog" }, + * { IsAnswer: false, CommentMessage: "We need to add a link", Date: 1688587967245, DateUTC: 1688569967245, QuoteText: "OnlyOffice" } + * ] + * } + * } */ /** * Returns a report about all the comments added to the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {CommentReport} */ ApiDocument.prototype.GetCommentsReport = function(){ return new CommentReport(); }; @@ -1813,30 +2340,44 @@ ApiDocument.prototype.GetCommentsReport = function(){ return new CommentReport() */ /** - * Record of one review change. + * Represents a single review change record. * @typedef {Object} ReviewReportRecord - * @property {ReviewReportRecordType} Type - Review record type. - * @property {string} [Value=undefined] - Review change value that is set for the "TextAdd" and "TextRem" types only. - * @property {number} Date - The time when this change was made. + * @property {ReviewReportRecordType} Type The review record type. + * @property {string} [Value] The review change value (only for "TextAdd" and "TextRem" types). + * @property {number} Date The timestamp of the change. + * @property {ApiParagraph | ApiTable} ReviewedElement The element that was reviewed. */ /** - * Report on all review changes. - * This is a dictionary where the keys are usernames. - * @typedef {Object.>} ReviewReport + * Represents a user's review history. + * @typedef {Object} UserReviewChanges + * @property {ReviewReportRecord[]} reviews A list of review records. + */ + +/** + * A dictionary of users and their review changes. + * @typedef {Object} ReviewReport + * @property {UserReviewChanges} [username] The review changes grouped by username. * @example * { - * "John Smith" : [{Type: 'TextRem', Value: 'Hello, Mark!', Date: 1679941734161}, - * {Type: 'TextAdd', Value: 'Dear Mr. Pottato.', Date: 1679941736189}], - * "Mark Pottato" : [{Type: 'ParaRem', Date: 1679941755942}, - * {Type: 'TextPr', Date: 1679941757832}] + * "John Smith": { + * reviews: [ + * { Type: "TextRem", Value: "Hello, Mark!", Date: 1679941734161, ReviewedElement: ApiParagraph }, + * { Type: "TextAdd", Value: "Dear Mr. Pottato.", Date: 1679941736189, ReviewedElement: ApiParagraph } + * ] + * }, + * "Mark Pottato": { + * reviews: [ + * { Type: "ParaRem", Date: 1679941755942, ReviewedElement: ApiParagraph }, + * { Type: "TextPr", Date: 1679941757832, ReviewedElement: ApiParagraph } + * ] + * } * } */ /** * Returns a report about every change which was made to the document in the review mode. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ReviewReport} */ ApiDocument.prototype.GetReviewReport = function(){ return new ReviewReport(); }; @@ -1844,19 +2385,17 @@ ApiDocument.prototype.GetReviewReport = function(){ return new ReviewReport(); } /** * Finds and replaces the text. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {Object} oProperties - The properties to find and replace. * @param {string} oProperties.searchString - Search string. * @param {string} oProperties.replaceString - Replacement string. * @param {string} [oProperties.matchCase=true] - Case sensitive or not. - * + * @returns {boolean} */ -ApiDocument.prototype.SearchAndReplace = function(oProperties){}; +ApiDocument.prototype.SearchAndReplace = function(oProperties){ return true; }; /** * Returns a list of all the content controls from the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt[] | ApiInlineLvlSdt[]} */ ApiDocument.prototype.GetAllContentControls = function(){ return [new ApiBlockLvlSdt()]; }; @@ -1864,7 +2403,6 @@ ApiDocument.prototype.GetAllContentControls = function(){ return [new ApiBlockLv /** * Returns a list of all tags that are used for all content controls in the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {String[]} */ ApiDocument.prototype.GetTagsOfAllContentControls = function(){ return [""]; }; @@ -1872,7 +2410,6 @@ ApiDocument.prototype.GetTagsOfAllContentControls = function(){ return [""]; }; /** * Returns a list of all tags that are used for all forms in the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {String[]} */ ApiDocument.prototype.GetTagsOfAllForms = function(){ return [""]; }; @@ -1880,7 +2417,6 @@ ApiDocument.prototype.GetTagsOfAllForms = function(){ return [""]; }; /** * Returns a list of all content controls in the document with the specified tag name. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param sTag {string} - Content control tag. * @returns {ApiBlockLvlSdt[] | ApiInlineLvlSdt[]} */ @@ -1889,11 +2425,47 @@ ApiDocument.prototype.GetContentControlsByTag = function(sTag){ return [new ApiB /** * Returns a list of all forms in the document with the specified tag name. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param sTag {string} - Form tag. - * @returns {ApiBlockLvlSdt[] | ApiInlineLvlSdt[]} + * @returns {ApiForm[]} */ -ApiDocument.prototype.GetFormsByTag = function(sTag){ return [new ApiBlockLvlSdt()]; }; +ApiDocument.prototype.GetFormsByTag = function(sTag){ return [new ApiForm()]; }; + +/** + * Returns a list of all forms in the document with the specified role name. + * @memberof ApiDocument + * @param role {string} - The form role. + * @returns {ApiForm[]} + * @since 9.0.0 + */ +ApiDocument.prototype.GetFormsByRole = function(role){ return [new ApiForm()]; }; + +/** + * Returns a list of all forms in the document with the specified key. + * @memberof ApiDocument + * @param key {string} - The form key. + * @returns {ApiForm[]} + * @since 9.0.0 + */ +ApiDocument.prototype.GetFormsByKey = function(key){ return [new ApiForm()]; }; + +/** + * Returns a list of all form keys attached to the specified role. + * @memberof ApiDocument + * @param role {string} - The form role. + * @returns {string[]} - A list of all form keys attached to the specified role. + * @since 9.0.0 + */ +ApiDocument.prototype.GetFormKeysByRole = function(role){ return [""]; }; + +/** + * Returns the form value for the specified key. For a group of radio buttons returns Choice, i.e. the name of the selected item. + * @memberof ApiDocument + * @param key {string} - The form key. + * @returns {null | boolean | string} Returns true/false for checkboxes and string for other form types. Returns null if + * there is no form with the specified key. + * @since 9.0.0 + */ +ApiDocument.prototype.GetFormValueByKey = function(key){ return null; }; /** * The specific form type. @@ -1920,7 +2492,6 @@ ApiDocument.prototype.GetFormsByTag = function(sTag){ return [new ApiBlockLvlSdt * Returns the data from all forms present in the current document. * If a form was created and not assigned to any part of the document, it won't appear in this list. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {Array.} * @since 8.0.0 */ @@ -1929,24 +2500,23 @@ ApiDocument.prototype.GetFormsData = function(){ return []; }; /** * Sets the data to the specified forms. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {Array.} arrData - An array of form data to set to the specified forms. + * @returns {boolean} * @since 8.0.0 */ -ApiDocument.prototype.SetFormsData = function(arrData){}; +ApiDocument.prototype.SetFormsData = function(arrData){ return true; }; /** * Sets the change tracking mode. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param isTrack {boolean} - Specifies if the change tracking mode is set or not. + * @returns {boolean} */ -ApiDocument.prototype.SetTrackRevisions = function(isTrack){}; +ApiDocument.prototype.SetTrackRevisions = function(isTrack){ return true; }; /** * Checks if change tracking mode is enabled or not. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiDocument.prototype.IsTrackRevisions = function(){ return true; }; @@ -1954,25 +2524,22 @@ ApiDocument.prototype.IsTrackRevisions = function(){ return true; }; /** * Returns a Range object that represents the part of the document contained in the specified document. * @memberof ApiDocument - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character in the current element. - * @param {Number} End - End character in the current element. + * @param {Number} Start - Start position index in the current element. + * @param {Number} End - End position index in the current element. * @returns {ApiRange} - * */ + */ ApiDocument.prototype.GetRange = function(Start, End){ return new ApiRange(); }; /** * Returns a range object by the current selection. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiRange | null} - returns null if selection doesn't exist. - * */ + */ ApiDocument.prototype.GetRangeBySelect = function(){ return new ApiRange(); }; /** * Returns the last document element. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {DocumentElement} */ ApiDocument.prototype.Last = function(){ return new DocumentElement(); }; @@ -1980,27 +2547,14 @@ ApiDocument.prototype.Last = function(){ return new DocumentElement(); }; /** * Removes a bookmark from the document, if one exists. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {string} sName - The bookmark name. * @returns {boolean} - returns false if param is invalid. */ ApiDocument.prototype.DeleteBookmark = function(sName){ return true; }; -/** - * Adds a comment to the document. - * @memberof ApiDocument - * @typeofeditors ["CDE"] - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). - * @returns {ApiComment} - Returns null if the comment was not added. - */ -ApiDocument.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; - /** * Returns a bookmark range. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {string} sName - The bookmark name. * @returns {ApiRange | null} - returns null if sName is invalid. */ @@ -2009,7 +2563,6 @@ ApiDocument.prototype.GetBookmarkRange = function(sName){ return new ApiRange(); /** * Returns a collection of section objects in the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiSection[]} */ ApiDocument.prototype.GetSections = function(){ return [new ApiSection()]; }; @@ -2019,22 +2572,20 @@ ApiDocument.prototype.GetSections = function(){ return [new ApiSection()]; }; * This method can be a little bit slow, because it runs the document calculation * process to arrange tables on the specified page. * @memberof ApiDocument - * @typeofeditors ["CDE"] - * @param {number} nPage - The page number. + * @param {number} nPage - The page index. * @returns {ApiTable[]} */ ApiDocument.prototype.GetAllTablesOnPage = function(nPage){ return [new ApiTable()]; }; /** - * Adds a shape to the specified page. + * Adds a drawing to the specified page. * This method can be a little bit slow, because it runs the document calculation * process to arrange tables on the specified page. * @memberof ApiDocument - * @typeofeditors ["CDE"] - * @param oDrawing {ApiDrawing} - A shape to add to the page. - * @param nPage {number} - The page number. - * @param x {EMU} - The X coordinate in English measure units. - * @param y {EMU} - The Y coordinate in English measure units. + * @param {ApiDrawing} oDrawing - A drawing to add to the page. + * @param {number} nPage - The page index. + * @param {EMU} x - The X coordinate in English measure units. + * @param {EMU} y - The Y coordinate in English measure units. * @returns {boolean} */ ApiDocument.prototype.AddDrawingToPage = function(oDrawing, nPage, x, y){ return true; }; @@ -2042,14 +2593,13 @@ ApiDocument.prototype.AddDrawingToPage = function(oDrawing, nPage, x, y){ return /** * Removes the current selection. * @memberof ApiDocument - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDocument.prototype.RemoveSelection = function(){}; +ApiDocument.prototype.RemoveSelection = function(){ return true; }; /** * Searches for a scope of a document object. The search results are a collection of ApiRange objects. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {string} sText - Search string. * @param {boolean} isMatchCase - Case sensitive or not. * @returns {ApiRange[]} @@ -2059,7 +2609,6 @@ ApiDocument.prototype.Search = function(sText, isMatchCase){ return [new ApiRang /** * Converts a document to Markdown. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {boolean} [bHtmlHeadings=false] - Defines if the HTML headings and IDs will be generated when the Markdown renderer of your target platform does not handle Markdown-style IDs. * @param {boolean} [bBase64img=false] - Defines if the images will be created in the base64 format. * @param {boolean} [bDemoteHeadings=false] - Defines if all heading levels in your document will be demoted to conform with the following standard: single H1 as title, H2 as top-level heading in the text body. @@ -2072,7 +2621,6 @@ ApiDocument.prototype.ToMarkdown = function(bHtmlHeadings, bBase64img, bDemoteHe /** * Converts a document to HTML. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {boolean} [bHtmlHeadings=false] - Defines if the HTML headings and IDs will be generated when the Markdown renderer of your target platform does not handle Markdown-style IDs. * @param {boolean} [bBase64img=false] - Defines if the images will be created in the base64 format. * @param {boolean} [bDemoteHeadings=false] - Defines if all heading levels in your document will be demoted to conform with the following standard: single H1 as title, H2 as top-level heading in the text body. @@ -2085,17 +2633,15 @@ ApiDocument.prototype.ToHtml = function(bHtmlHeadings, bBase64img, bDemoteHeadin /** * Inserts a watermark on each document page. * @memberof ApiDocument - * @typeofeditors ["CDE"] - * @param {?string} [sText="WATERMARK"] - Watermark text. - * @param {?boolean} [bIsDiagonal=false] - Specifies if the watermark is placed diagonally (true) or horizontally (false). - * @returns {ApiDrawing} - The object which represents the inserted watermark. Returns null if the watermark type is "none". + * @param {string} [sText="WATERMARK"] - Watermark text. + * @param {boolean} [bIsDiagonal=false] - Specifies if the watermark is placed diagonally (true) or horizontally (false). + * @returns {boolean} */ -ApiDocument.prototype.InsertWatermark = function(sText, bIsDiagonal){ return new ApiDrawing(); }; +ApiDocument.prototype.InsertWatermark = function(sText, bIsDiagonal){ return true; }; /** * Returns the watermark settings in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiWatermarkSettings} - The object which represents the watermark settings. */ ApiDocument.prototype.GetWatermarkSettings = function(){ return new ApiWatermarkSettings(); }; @@ -2103,7 +2649,6 @@ ApiDocument.prototype.GetWatermarkSettings = function(){ return new ApiWatermark /** * Sets the watermark settings in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {ApiWatermarkSettings} Settings - The object which represents the watermark settings. * @returns {ApiDrawing} - The object which represents the watermark drawing if the watermark type in Settings is not "none". */ @@ -2112,30 +2657,38 @@ ApiDocument.prototype.SetWatermarkSettings = function(Settings){ return new ApiD /** * Removes a watermark from the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDocument.prototype.RemoveWatermark = function(){}; +ApiDocument.prototype.RemoveWatermark = function(){ return true; }; /** * Updates all tables of contents in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {boolean} [bOnlyPageNumbers=false] - Specifies that only page numbers will be updated. + * @returns {boolean} */ -ApiDocument.prototype.UpdateAllTOC = function(bOnlyPageNumbers){}; +ApiDocument.prototype.UpdateAllTOC = function(bOnlyPageNumbers){ return true; }; /** * Updates all tables of figures in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {boolean} [bOnlyPageNumbers=false] - Specifies that only page numbers will be updated. + * @returns {boolean} */ -ApiDocument.prototype.UpdateAllTOF = function(bOnlyPageNumbers){}; +ApiDocument.prototype.UpdateAllTOF = function(bOnlyPageNumbers){ return true; }; + +/** + * Updates all fields in the document. + * @memberof ApiDocument + * @param {boolean} [bBySelection=false] - Specifies whether all fields will be updated within the selection. + * @returns {boolean} + * @since 8.2.0 + */ +ApiDocument.prototype.UpdateAllFields = function(bBySelection){ return true; }; /** * Converts the ApiDocument object into the JSON object. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {boolean} bWriteDefaultTextPr - Specifies if the default text properties will be written to the JSON object or not. * @param {boolean} bWriteDefaultParaPr - Specifies if the default paragraph properties will be written to the JSON object or not. * @param {boolean} bWriteTheme - Specifies if the document theme will be written to the JSON object or not. @@ -2149,7 +2702,6 @@ ApiDocument.prototype.ToJSON = function(bWriteDefaultTextPr, bWriteDefaultParaPr /** * Returns all existing forms in the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiForm[]} */ ApiDocument.prototype.GetAllForms = function(){ return [new ApiForm()]; }; @@ -2157,9 +2709,9 @@ ApiDocument.prototype.GetAllForms = function(){ return [new ApiForm()]; }; /** * Clears all forms in the document. * @memberof ApiDocument - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDocument.prototype.ClearAllFields = function(){}; +ApiDocument.prototype.ClearAllFields = function(){ return true; }; /** * Sets the highlight to the forms in the document. @@ -2168,14 +2720,13 @@ ApiDocument.prototype.ClearAllFields = function(){}; * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} [bNone=false] - Defines that highlight will not be set. - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDocument.prototype.SetFormsHighlight = function(r, g, b, bNone){}; +ApiDocument.prototype.SetFormsHighlight = function(r, g, b, bNone){ return true; }; /** * Returns all comments from the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiComment[]} */ ApiDocument.prototype.GetAllComments = function(){ return [new ApiComment()]; }; @@ -2183,7 +2734,6 @@ ApiDocument.prototype.GetAllComments = function(){ return [new ApiComment()]; }; /** * Returns a comment from the current document by its ID. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {string} sId - The comment ID. * @returns {ApiComment} */ @@ -2192,7 +2742,6 @@ ApiDocument.prototype.GetCommentById = function(sId){ return new ApiComment(); } /** * Returns all numbered paragraphs from the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiParagraph[]} */ ApiDocument.prototype.GetAllNumberedParagraphs = function(){ return [new ApiParagraph()]; }; @@ -2200,7 +2749,6 @@ ApiDocument.prototype.GetAllNumberedParagraphs = function(){ return [new ApiPara /** * Returns all heading paragraphs from the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiParagraph[]} */ ApiDocument.prototype.GetAllHeadingParagraphs = function(){ return [new ApiParagraph()]; }; @@ -2208,7 +2756,6 @@ ApiDocument.prototype.GetAllHeadingParagraphs = function(){ return [new ApiParag /** * Returns the first paragraphs from all footnotes in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiParagraph[]} */ ApiDocument.prototype.GetFootnotesFirstParagraphs = function(){ return [new ApiParagraph()]; }; @@ -2216,7 +2763,6 @@ ApiDocument.prototype.GetFootnotesFirstParagraphs = function(){ return [new ApiP /** * Returns the first paragraphs from all endnotes in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiParagraph[]} */ ApiDocument.prototype.GetEndNotesFirstParagraphs = function(){ return [new ApiParagraph()]; }; @@ -2224,7 +2770,6 @@ ApiDocument.prototype.GetEndNotesFirstParagraphs = function(){ return [new ApiPa /** * Returns all caption paragraphs of the specified type from the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {CaptionLabel | string} sCaption - The caption label ("Equation", "Figure", "Table", or another caption label). * @returns {ApiParagraph[]} */ @@ -2233,42 +2778,49 @@ ApiDocument.prototype.GetAllCaptionParagraphs = function(sCaption){ return [new /** * Accepts all changes made in review mode. * @memberof ApiDocument - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDocument.prototype.AcceptAllRevisionChanges = function(){}; +ApiDocument.prototype.AcceptAllRevisionChanges = function(){ return true; }; /** * Rejects all changes made in review mode. * @memberof ApiDocument - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDocument.prototype.RejectAllRevisionChanges = function(){}; +ApiDocument.prototype.RejectAllRevisionChanges = function(){ return true; }; /** * Returns an array with names of all bookmarks in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {string[]} */ ApiDocument.prototype.GetAllBookmarksNames = function(){ return [""]; }; +/** + * Returns a bookmark by its name from the current document. + * @memberof ApiDocument + * @param {string} sBookmarkName - The bookmark name. + * @returns {ApiBookmark} + * @since 8.3.0 + */ +ApiDocument.prototype.GetBookmark = function(sBookmarkName){ return new ApiBookmark(); }; + /** * Returns all the selected drawings in the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiShape[] | ApiImage[] | ApiChart[] | ApiDrawing[]} */ ApiDocument.prototype.GetSelectedDrawings = function(){ return [new ApiShape()]; }; /** * Replaces the current image with an image specified. - * @typeofeditors ["CDE"] * @memberof ApiDocument * @param {string} sImageUrl - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). * @param {EMU} Width - The image width in English measure units. * @param {EMU} Height - The image height in English measure units. + * @returns {boolean} */ -ApiDocument.prototype.ReplaceCurrentImage = function(sImageUrl, Width, Height){}; +ApiDocument.prototype.ReplaceCurrentImage = function(sImageUrl, Width, Height){ return true; }; /** * Replaces a drawing with a new drawing. @@ -2276,7 +2828,6 @@ ApiDocument.prototype.ReplaceCurrentImage = function(sImageUrl, Width, Height){} * @param {ApiDrawing} oOldDrawing - A drawing which will be replaced. * @param {ApiDrawing} oNewDrawing - A drawing to replace the old drawing. * @param {boolean} [bSaveOldDrawingPr=false] - Specifies if the old drawing settings will be saved. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiDocument.prototype.ReplaceDrawing = function(oOldDrawing, oNewDrawing, bSaveOldDrawingPr){ return true; }; @@ -2284,7 +2835,6 @@ ApiDocument.prototype.ReplaceDrawing = function(oOldDrawing, oNewDrawing, bSaveO /** * Adds a footnote for the selected text (or the current position if the selection doesn't exist). * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiDocumentContent} */ ApiDocument.prototype.AddFootnote = function(){ return new ApiDocumentContent(); }; @@ -2292,7 +2842,6 @@ ApiDocument.prototype.AddFootnote = function(){ return new ApiDocumentContent(); /** * Adds an endnote for the selected text (or the current position if the selection doesn't exist). * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiDocumentContent} */ ApiDocument.prototype.AddEndnote = function(){ return new ApiDocumentContent(); }; @@ -2304,23 +2853,22 @@ ApiDocument.prototype.AddEndnote = function(){ return new ApiDocumentContent(); * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} [bNone=false] - Defines that highlight will not be set. - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDocument.prototype.SetControlsHighlight = function(r, g, b, bNone){}; +ApiDocument.prototype.SetControlsHighlight = function(r, g, b, bNone){ return true; }; /** * Adds a table of content to the current document. * Please note that the new table of contents replaces the existing table of contents. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {TocPr} [oTocPr={}] - Table of contents properties. + * @returns {boolean} */ -ApiDocument.prototype.AddTableOfContents = function(oTocPr){}; +ApiDocument.prototype.AddTableOfContents = function(oTocPr){ return true; }; /** * Adds a table of figures to the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @param {TofPr} [oTofPr={}] - Table of figures properties. * Please note that the table of figures properties will be filled with the default properties if they are undefined. * @param {boolean} [bReplace=true] - Specifies whether to replace the selected table of figures instead of adding a new one. @@ -2330,13 +2878,12 @@ ApiDocument.prototype.AddTableOfFigures = function(oTofPr, bReplace){ return tru /** * Returns the document statistics represented as an object with the following parameters: - * * PageCount - number of pages; - * * WordsCount - number of words; - * * ParagraphCount - number of paragraphs; - * * SymbolsCount - number of symbols; - * * SymbolsWSCount - number of symbols with spaces. + * PageCount - number of pages; + * WordsCount - number of words; + * ParagraphCount - number of paragraphs; + * SymbolsCount - number of symbols; + * SymbolsWSCount - number of symbols with spaces. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {object} */ ApiDocument.prototype.GetStatistics = function(){ return new object(); }; @@ -2346,23 +2893,214 @@ ApiDocument.prototype.GetStatistics = function(){ return new object(); }; * This method can be slow for large documents because it runs the document calculation * process before the full recalculation. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {number} */ ApiDocument.prototype.GetPageCount = function(){ return 0; }; +/** + * Returns the index of the current page. + * @memberof ApiDocument + * @returns {number} + * @since 8.3.0 + */ +ApiDocument.prototype.GetCurrentPage = function(){ return 0; }; + +/** + * Returns the indexes of the currently visible pages. + * @memberof ApiDocument + * @returns {number[]} + * @since 8.3.0 + */ +ApiDocument.prototype.GetCurrentVisiblePages = function(){ return [0]; }; + /** * Returns all styles of the current document. * @memberof ApiDocument - * @typeofeditors ["CDE"] * @returns {ApiStyle[]} */ ApiDocument.prototype.GetAllStyles = function(){ return [new ApiStyle()]; }; +/** + * Returns the document information: + * Application - the application the document was created with. + * CreatedRaw - the date and time when the file was created. + * Created - the parsed date and time when the file was created. + * LastModifiedRaw - the date and time when the file was last modified. + * LastModified - the parsed date and time when the file was last modified. + * LastModifiedBy - the name of the user who made the latest change to the document. + * Authors - the persons who created the file. + * Title - the document title (this property allows you to simplify your documents classification). + * Tags - the document tags (this property allows you to simplify your documents classification). + * Subject - the document subject (this property allows you to simplify your documents classification). + * Comment - the comment to the document (this property allows you to simplify your documents classification). + * @memberof ApiDocument + * @returns {object} + * @since 8.1.0 + */ +ApiDocument.prototype.GetDocumentInfo = function(){ return new object(); }; + +/** + * Returns the current word or part of the current word. + * @param {undefined | "before" | "after"} sWordPart - The desired part of the current word to be returned. + * @memberof ApiDocument + * @returns {string} + * @since 8.2.0 + */ +ApiDocument.prototype.GetCurrentWord = function(sWordPart){ return ""; }; + +/** + * Replaces the current word or part of the current word with the specified text. + * @param sReplace {string} - The string to replace the current word with. + * @param {undefined | "before" | "after"} sPart - The desired part of the current word to be replaced. + * @memberof ApiDocument + * @returns {boolean} + * @since 8.2.0 + */ +ApiDocument.prototype.ReplaceCurrentWord = function(sReplace, sPart){ return true; }; + +/** + * Selects the current word if it is possible. + * @memberof ApiDocument + * @returns {object} + * @since 8.2.0 + */ +ApiDocument.prototype.SelectCurrentWord = function(){ return new object(); }; + +/** + * Adds a comment to the current document selection, or to the current word if no text is selected. + * @memberof ApiDocument + * @param {string} sText - The comment text. + * @param {string} [sAuthor] - The author's name. + * @param {string} [sUserId] - The user ID of the comment author. + * @returns {ApiComment} - Returns null if the comment was not added. + */ +ApiDocument.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; + +/** + * Returns the current sentence or part of the current sentence. + * @param {undefined | "before" | "after"} sPart - The desired part of the current sentence to be returned. + * @memberof ApiDocument + * @returns {string} + * @since 8.2.0 + */ +ApiDocument.prototype.GetCurrentSentence = function(sPart){ return ""; }; + +/** + * Replaces the current sentence or part of the current sentence with the specified text. + * @param sReplace {string} - The string to replace the current sentence with. + * @param {undefined | "before" | "after"} sPart - The desired part of the current sentence to be replaced. + * @memberof ApiDocument + * @returns {boolean} + * @since 8.2.0 + */ +ApiDocument.prototype.ReplaceCurrentSentence = function(sReplace, sPart){ return true; }; + +/** + * Adds a math equation to the current document. + * @param sText {string} - An equation written as a linear text string. + * @param {"unicode" | "latex"} [sFormat="unicode"] - The format of the specified linear representation. + * @memberof ApiDocument + * @returns {boolean} + * @since 8.2.0 + */ +ApiDocument.prototype.AddMathEquation = function(sText, sFormat){ return true; }; + +/** + * Groups an array of drawings in the current document. + * @memberof ApiDocument + * @param {DrawingForGroup[]} aDrawings - An array of drawings to group. + * @returns {ApiGroup} + * @since 8.3.0 + */ +ApiDocument.prototype.GroupDrawings = function(aDrawings){ return new ApiGroup(); }; + +/** + * Moves a cursor to a specified position of the current document. + * If there is any selection in the document, it will be removed. + * @memberof ApiDocument + * @param {number} [nPos=0] - The desired cursor position. + * @returns {boolean} + * @since 9.0.0 + */ +ApiDocument.prototype.MoveCursorToPos = function(nPos){ return true; }; + +/** + * Adds a new checkbox content control to the document. + * @memberof ApiDocument + * @since 9.0.0 + * @param {ContentControlCheckBoxPr} checkBoxPr The configuration object for the checkbox. + * @returns {ApiInlineLvlSdt} An instance of the ApiInlineLvlSdt object representing the checkbox content control. + */ +ApiDocument.prototype.AddCheckBoxContentControl = function(checkBoxPr){ return new ApiInlineLvlSdt(); }; + +/** + * Adds a new picture content control to the document. + * @memberof ApiDocument + * @since 9.0.0 + * @param {EMU} [width] - The optional width of the image. + * @param {EMU} [height] - The optional height of the image. + * @returns {ApiInlineLvlSdt} An instance of the ApiInlineLvlSdt object representing the picture content control. + */ +ApiDocument.prototype.AddPictureContentControl = function(width, height){ return new ApiInlineLvlSdt(); }; + +/** + * Adds a new combo box content control to the document. + * @memberof ApiDocument + * @since 9.0.0 + * @param {ContentControlListItem[]} [list] - An array of objects representing the items in the combo box. + * @param {string} [selected] - The optional value of the item that should be selected by default (must match one of the ListItem.Value). + * @returns {ApiInlineLvlSdt} + */ +ApiDocument.prototype.AddComboBoxContentControl = function(list, selected){ return new ApiInlineLvlSdt(); }; + +/** + * Adds a new drop-down list content control to the document. + * @memberof ApiDocument + * @since 9.0.0 + * @param {ContentControlListItem[]} [list] - An array of objects representing the items in the drop-down list. + * @param {string} [selected] - The optional value of the item that should be selected by default (must match one of the ListItem.Value). + * @returns {ApiInlineLvlSdt} + */ +ApiDocument.prototype.AddDropDownListContentControl = function(list, selected){ return new ApiInlineLvlSdt(); }; + +/** + * Adds a new date picker content control to the document. + * @memberof ApiDocument + * @since 9.0.0 + * @param {ContentControlDatePr} [datePickerPr] - The optional date picker properties. + * @returns {ApiInlineLvlSdt} + */ +ApiDocument.prototype.AddDatePickerContentControl = function(datePickerPr){ return new ApiInlineLvlSdt(); }; + +/** + * Retrieves the custom XML manager associated with the document. + * This manager allows manipulation and access to custom XML parts within the document. + * @memberof ApiDocument + * @since 9.0.0 + * @returns {ApiCustomXmlParts|null} Returns an instance of ApiCustomXmlParts if the custom XML manager exists, otherwise returns null. + */ +ApiDocument.prototype.GetCustomXmlParts = function(){ return new ApiCustomXmlParts(); }; + +/** + * Retrieves the core properties interface for the current document. + * This method is used to view or modify standard metadata such as title, author, and keywords. + * @memberof ApiDocument + * @returns {ApiCore} - The core document properties object. + * @since 9.0.0 + */ +ApiDocument.prototype.GetCore = function () { return new ApiCore(); }; + +/** + * Retrieves the custom properties from the document. + * @memberof ApiDocument + * @returns {ApiCustomProperties} + * @since 9.0.0 + */ +ApiDocument.prototype.GetCustomProperties = function () { return new ApiCustomProperties(); }; + /** * Returns a type of the ApiParagraph class. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"paragraph"} */ ApiParagraph.prototype.GetClassType = function(){ return ""; }; @@ -2370,7 +3108,6 @@ ApiParagraph.prototype.GetClassType = function(){ return ""; }; /** * Adds some text to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} [sText=""] - The text that we want to insert into the current document element. * @returns {ApiRun} */ @@ -2379,7 +3116,6 @@ ApiParagraph.prototype.AddText = function(sText){ return new ApiRun(); }; /** * Adds a page break and starts the next element from the next page. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddPageBreak = function(){ return new ApiRun(); }; @@ -2387,7 +3123,6 @@ ApiParagraph.prototype.AddPageBreak = function(){ return new ApiRun(); }; /** * Adds a line break to the current position and starts the next element from a new line. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddLineBreak = function(){ return new ApiRun(); }; @@ -2395,7 +3130,6 @@ ApiParagraph.prototype.AddLineBreak = function(){ return new ApiRun(); }; /** * Adds a column break to the current position and starts the next element from a new column. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddColumnBreak = function(){ return new ApiRun(); }; @@ -2403,7 +3137,6 @@ ApiParagraph.prototype.AddColumnBreak = function(){ return new ApiRun(); }; /** * Inserts a number of the current document page into the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddPageNumber = function(){ return new ApiRun(); }; @@ -2411,7 +3144,6 @@ ApiParagraph.prototype.AddPageNumber = function(){ return new ApiRun(); }; /** * Inserts a number of pages in the current document into the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddPagesCount = function(){ return new ApiRun(); }; @@ -2420,7 +3152,6 @@ ApiParagraph.prototype.AddPagesCount = function(){ return new ApiRun(); }; * Returns the text properties of the paragraph mark which is used to mark the paragraph end. The mark can also acquire * common text properties like bold, italic, underline, etc. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiTextPr} */ ApiParagraph.prototype.GetParagraphMarkTextPr = function(){ return new ApiTextPr(); }; @@ -2428,7 +3159,6 @@ ApiParagraph.prototype.GetParagraphMarkTextPr = function(){ return new ApiTextPr /** * Returns the paragraph properties. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParaPr} */ ApiParagraph.prototype.GetParaPr = function(){ return new ApiParaPr(); }; @@ -2436,7 +3166,6 @@ ApiParagraph.prototype.GetParaPr = function(){ return new ApiParaPr(); }; /** * Returns the numbering definition and numbering level for the numbered list. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiNumberingLevel} */ ApiParagraph.prototype.GetNumbering = function(){ return new ApiNumberingLevel(); }; @@ -2444,16 +3173,14 @@ ApiParagraph.prototype.GetNumbering = function(){ return new ApiNumberingLevel() /** * Specifies that the current paragraph references the numbering definition instance in the current document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] - * @see Same as {@link ApiParagraph#SetNumPr} * @param {ApiNumberingLevel} oNumberingLevel - The numbering level which will be used for assigning the numbers to the paragraph. + * @returns {boolean} */ -ApiParagraph.prototype.SetNumbering = function(oNumberingLevel){}; +ApiParagraph.prototype.SetNumbering = function(oNumberingLevel){ return true; }; /** * Returns a number of elements in the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {number} */ ApiParagraph.prototype.GetElementsCount = function(){ return 0; }; @@ -2461,7 +3188,6 @@ ApiParagraph.prototype.GetElementsCount = function(){ return 0; }; /** * Returns a paragraph element using the position specified. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The position where the element which content we want to get must be located. * @returns {ParagraphContent} */ @@ -2473,24 +3199,23 @@ ApiParagraph.prototype.GetElement = function(nPos){ return new ParagraphContent( * a new empty run is automatically created. If you want to add * content to this run, use the {@link ApiParagraph#GetElement} method. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {number} nPos - The element position which we want to remove from the paragraph. + * @returns {boolean} */ -ApiParagraph.prototype.RemoveElement = function(nPos){}; +ApiParagraph.prototype.RemoveElement = function(nPos){ return true; }; /** * Removes all the elements from the current paragraph. * When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add * content to this run, use the {@link ApiParagraph#GetElement} method. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiParagraph.prototype.RemoveAllElements = function(){}; +ApiParagraph.prototype.RemoveAllElements = function(){ return true; }; /** * Deletes the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} - returns false if paragraph haven't parent. */ ApiParagraph.prototype.Delete = function(){ return true; }; @@ -2498,7 +3223,6 @@ ApiParagraph.prototype.Delete = function(){ return true; }; /** * Returns the next paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph | null} - returns null if paragraph is last. */ ApiParagraph.prototype.GetNext = function(){ return new ApiParagraph(); }; @@ -2506,7 +3230,6 @@ ApiParagraph.prototype.GetNext = function(){ return new ApiParagraph(); }; /** * Returns the previous paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph} - returns null if paragraph is first. */ ApiParagraph.prototype.GetPrevious = function(){ return new ApiParagraph(); }; @@ -2514,7 +3237,6 @@ ApiParagraph.prototype.GetPrevious = function(){ return new ApiParagraph(); }; /** * Creates a paragraph copy. Ingnore comments, footnote references, complex fields. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiParagraph} */ ApiParagraph.prototype.Copy = function(){ return new ApiParagraph(); }; @@ -2522,7 +3244,6 @@ ApiParagraph.prototype.Copy = function(){ return new ApiParagraph(); }; /** * Adds an element to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ParagraphContent} oElement - The document element which will be added at the current position. Returns false if the * oElement type is not supported by a paragraph. * @param {number} [nPos] - The position where the current element will be added. If this value is not @@ -2535,7 +3256,6 @@ ApiParagraph.prototype.AddElement = function(oElement, nPos){ return true; }; /** * Adds a tab stop to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiParagraph.prototype.AddTabStop = function(){ return new ApiRun(); }; @@ -2543,7 +3263,6 @@ ApiParagraph.prototype.AddTabStop = function(){ return new ApiRun(); }; /** * Adds a drawing object (image, shape or chart) to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {ApiDrawing} oDrawing - The object which will be added to the current paragraph. * @returns {ApiRun} */ @@ -2552,7 +3271,6 @@ ApiParagraph.prototype.AddDrawing = function(oDrawing){ return new ApiRun(); }; /** * Adds an inline container. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {ApiInlineLvlSdt} oSdt - An inline container. If undefined or null, then new class ApiInlineLvlSdt will be created and added to the paragraph. * @returns {ApiInlineLvlSdt} */ @@ -2562,10 +3280,9 @@ ApiParagraph.prototype.AddInlineLvlSdt = function(oSdt){ return new ApiInlineLvl * Adds a comment to the current paragraph. * Please note that this paragraph must be in the document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). + * @param {string} sText - The comment text. + * @param {string} [sAuthor] - The author's name. + * @param {string} [sUserId] - The user ID of the comment author. * @returns {ApiComment} - Returns null if the comment was not added. */ ApiParagraph.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; @@ -2573,7 +3290,6 @@ ApiParagraph.prototype.AddComment = function(sText, sAuthor, sUserId){ return ne /** * Adds a hyperlink to a paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {string} sLink - The link address. * @param {string} sScreenTipText - The screen tip text. * @returns {ApiHyperlink | null} - returns null if params are invalid. @@ -2583,17 +3299,15 @@ ApiParagraph.prototype.AddHyperlink = function(sLink, sScreenTipText){ return ne /** * Returns a Range object that represents the part of the document contained in the specified paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character in the current element. - * @param {Number} End - End character in the current element. + * @param {Number} Start - Start position index in the current element. + * @param {Number} End - End position index in the current element. * @returns {ApiRange} - * */ + */ ApiParagraph.prototype.GetRange = function(Start, End){ return new ApiRange(); }; /** * Adds an element to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {ParagraphContent} oElement - The document element which will be added at the current position. Returns false if the * oElement type is not supported by a paragraph. * @returns {boolean} Returns false if the type of oElement is not supported by paragraph @@ -2604,7 +3318,6 @@ ApiParagraph.prototype.Push = function(oElement){ return true; }; /** * Returns the last Run with text in the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiRun} Returns false if the paragraph doesn't containt the required run. */ ApiParagraph.prototype.GetLastRunWithText = function(){ return new ApiRun(); }; @@ -2612,7 +3325,6 @@ ApiParagraph.prototype.GetLastRunWithText = function(){ return new ApiRun(); }; /** * Sets the bold property to the text character. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} isBold - Specifies that the contents of this paragraph are displayed bold. * @returns {ApiParagraph} this */ @@ -2621,7 +3333,6 @@ ApiParagraph.prototype.SetBold = function(isBold){ return new ApiParagraph(); }; /** * Specifies that any lowercase characters in this paragraph are formatted for display only as their capital letter character equivalents. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} isCaps - Specifies that the contents of the current paragraph are displayed capitalized. * @returns {ApiParagraph} this */ @@ -2630,7 +3341,6 @@ ApiParagraph.prototype.SetCaps = function(isCaps){ return new ApiParagraph(); }; /** * Sets the text color to the current paragraph in the RGB format. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -2642,7 +3352,6 @@ ApiParagraph.prototype.SetColor = function(r, g, b, isAuto){ return new ApiParag /** * Specifies that the contents of this paragraph are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} isDoubleStrikeout - Specifies that the contents of the current paragraph are displayed double struck through. * @returns {ApiParagraph} this */ @@ -2651,7 +3360,6 @@ ApiParagraph.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return /** * Sets all 4 font slots with the specified font family. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {string} sFontFamily - The font family or families used for the current paragraph. * @returns {ApiParagraph} this */ @@ -2660,7 +3368,6 @@ ApiParagraph.prototype.SetFontFamily = function(sFontFamily){ return new ApiPara /** * Returns all font names from all elements inside the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {string[]} - The font names used for the current paragraph. */ ApiParagraph.prototype.GetFontNames = function(){ return [""]; }; @@ -2668,7 +3375,6 @@ ApiParagraph.prototype.GetFontNames = function(){ return [""]; }; /** * Sets the font size to the characters of the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {hps} nSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiParagraph} this */ @@ -2677,7 +3383,6 @@ ApiParagraph.prototype.SetFontSize = function(nSize){ return new ApiParagraph(); /** * Specifies a highlighting color which is applied as a background to the contents of the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE", "CPE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiParagraph} this */ @@ -2686,7 +3391,6 @@ ApiParagraph.prototype.SetHighlight = function(sColor){ return new ApiParagraph( /** * Sets the italic property to the text character. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} isItalic - Specifies that the contents of the current paragraph are displayed italicized. * @returns {ApiParagraph} this */ @@ -2696,7 +3400,6 @@ ApiParagraph.prototype.SetItalic = function(isItalic){ return new ApiParagraph() * Specifies an amount by which text is raised or lowered for this paragraph in relation to the default * baseline of the surrounding non-positioned text. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {hps} nPosition - Specifies a positive (raised text) or negative (lowered text) * measurement in half-points (1/144 of an inch). * @returns {ApiParagraph} this @@ -2707,7 +3410,6 @@ ApiParagraph.prototype.SetPosition = function(nPosition){ return new ApiParagrap * Specifies that all the small letter characters in this paragraph are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current paragraph are displayed capitalized two points smaller or not. * @returns {ApiParagraph} this */ @@ -2716,7 +3418,6 @@ ApiParagraph.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiParag /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiParagraph} this */ @@ -2725,7 +3426,6 @@ ApiParagraph.prototype.SetSpacing = function(nSpacing){ return new ApiParagraph( /** * Specifies that the contents of this paragraph are displayed with a single horizontal line through the center of the line. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} isStrikeout - Specifies that the contents of the current paragraph are displayed struck through. * @returns {ApiParagraph} this */ @@ -2735,7 +3435,6 @@ ApiParagraph.prototype.SetStrikeout = function(isStrikeout){ return new ApiParag * Specifies that the contents of this paragraph are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} isUnderline - Specifies that the contents of the current paragraph are displayed underlined. * @returns {ApiParagraph} this */ @@ -2743,11 +3442,10 @@ ApiParagraph.prototype.SetUnderline = function(isUnderline){ return new ApiParag /** * Specifies the alignment which will be applied to the contents of this paragraph in relation to the default appearance of the paragraph text: - * * "baseline" - the characters in the current paragraph will be aligned by the default text baseline. - * * "subscript" - the characters in the current paragraph will be aligned below the default text baseline. - * * "superscript" - the characters in the current paragraph will be aligned above the default text baseline. + * "baseline" - the characters in the current paragraph will be aligned by the default text baseline. + * "subscript" - the characters in the current paragraph will be aligned below the default text baseline. + * "superscript" - the characters in the current paragraph will be aligned above the default text baseline. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiParagraph | null} - returns null is sType is invalid. */ @@ -2756,7 +3454,6 @@ ApiParagraph.prototype.SetVertAlign = function(sType){ return new ApiParagraph() /** * Returns the last element of the paragraph which is not empty. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ParagraphContent} */ ApiParagraph.prototype.Last = function(){ return new ParagraphContent(); }; @@ -2764,7 +3461,6 @@ ApiParagraph.prototype.Last = function(){ return new ParagraphContent(); }; /** * Returns a collection of content control objects in the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiInlineLvlSdt[]} */ ApiParagraph.prototype.GetAllContentControls = function(){ return [new ApiInlineLvlSdt()]; }; @@ -2772,15 +3468,13 @@ ApiParagraph.prototype.GetAllContentControls = function(){ return [new ApiInline /** * Returns a collection of drawing objects in the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] - * @returns {ApiDrawing[]} + * @returns {Drawing[]} */ -ApiParagraph.prototype.GetAllDrawingObjects = function(){ return [new ApiDrawing()]; }; +ApiParagraph.prototype.GetAllDrawingObjects = function(){ return [new Drawing()]; }; /** * Returns a collection of shape objects in the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiShape[]} */ ApiParagraph.prototype.GetAllShapes = function(){ return [new ApiShape()]; }; @@ -2788,7 +3482,6 @@ ApiParagraph.prototype.GetAllShapes = function(){ return [new ApiShape()]; }; /** * Returns a collection of image objects in the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiImage[]} */ ApiParagraph.prototype.GetAllImages = function(){ return [new ApiImage()]; }; @@ -2796,7 +3489,6 @@ ApiParagraph.prototype.GetAllImages = function(){ return [new ApiImage()]; }; /** * Returns a collection of chart objects in the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiChart[]} */ ApiParagraph.prototype.GetAllCharts = function(){ return [new ApiChart()]; }; @@ -2804,7 +3496,6 @@ ApiParagraph.prototype.GetAllCharts = function(){ return [new ApiChart()]; }; /** * Returns a collection of OLE objects in the paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiOleObject[]} */ ApiParagraph.prototype.GetAllOleObjects = function(){ return [new ApiOleObject()]; }; @@ -2812,7 +3503,6 @@ ApiParagraph.prototype.GetAllOleObjects = function(){ return [new ApiOleObject() /** * Returns a content control that contains the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt | null} - returns null is parent content control doesn't exist. */ ApiParagraph.prototype.GetParentContentControl = function(){ return new ApiBlockLvlSdt(); }; @@ -2820,7 +3510,6 @@ ApiParagraph.prototype.GetParentContentControl = function(){ return new ApiBlock /** * Returns a table that contains the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null if parent table doesn't exist. */ ApiParagraph.prototype.GetParentTable = function(){ return new ApiTable(); }; @@ -2828,7 +3517,6 @@ ApiParagraph.prototype.GetParentTable = function(){ return new ApiTable(); }; /** * Returns a table cell that contains the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - returns null if parent cell doesn't exist. */ ApiParagraph.prototype.GetParentTableCell = function(){ return new ApiTableCell(); }; @@ -2839,17 +3527,15 @@ ApiParagraph.prototype.GetParentTableCell = function(){ return new ApiTableCell( * @param {object} oPr - The resulting string display properties. * @param {boolean} [oPr.Numbering=false] - Defines if the resulting string will include numbering or not. * @param {boolean} [oPr.Math=false] - Defines if the resulting string will include mathematical expressions or not. - * @param {string} [oPr.NewLineSeparator='\r'] - Defines how the line separator will be specified in the resulting string. - * @param {string} [oPr.TabSymbol='\t'] - Defines how the tab will be specified in the resulting string (does not apply to numbering). - * @typeofeditors ["CDE"] + * @param {string} [oPr.NewLineSeparator='\r'] - Defines how the line separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r". + * @param {string} [oPr.TabSymbol='\t'] - Defines how the tab will be specified in the resulting string (does not apply to numbering). Any symbol can be used. The default symbol is "\t". * @returns {string} */ ApiParagraph.prototype.GetText = function(oPr){ return ""; }; /** - * Returns the paragraph text properties. + * Returns the text properties for a paragraph end mark. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiTextPr} */ ApiParagraph.prototype.GetTextPr = function(){ return new ApiTextPr(); }; @@ -2857,7 +3543,6 @@ ApiParagraph.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** * Sets the paragraph text properties. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {ApiTextPr} oTextPr - The paragraph text properties. * @returns {boolean} - returns false if param is invalid. */ @@ -2866,7 +3551,6 @@ ApiParagraph.prototype.SetTextPr = function(oTextPr){ return true; }; /** * Wraps the paragraph object with a rich text content control. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {number} nType - Defines if this method returns the ApiBlockLvlSdt (nType === 1) or ApiParagraph (any value except 1) object. * @returns {ApiParagraph | ApiBlockLvlSdt} */ @@ -2875,7 +3559,6 @@ ApiParagraph.prototype.InsertInContentControl = function(nType){ return new ApiP /** * Inserts a paragraph at the specified position. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {string | ApiParagraph} paragraph - Text or paragraph. * @param {string} sPosition - The position where the text or paragraph will be inserted ("before" or "after" the paragraph specified). * @param {boolean} beRNewPara - Defines if this method returns a new paragraph (true) or the current paragraph (false). @@ -2886,7 +3569,6 @@ ApiParagraph.prototype.InsertParagraph = function(paragraph, sPosition, beRNewPa /** * Selects the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiParagraph.prototype.Select = function(){ return true; }; @@ -2894,7 +3576,6 @@ ApiParagraph.prototype.Select = function(){ return true; }; /** * Searches for a scope of a paragraph object. The search results are a collection of ApiRange objects. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {string} sText - Search string. * @param {boolean} isMatchCase - Case sensitive or not. * @returns {ApiRange[]} @@ -2904,15 +3585,14 @@ ApiParagraph.prototype.Search = function(sText, isMatchCase){ return [new ApiRan /** * Wraps the paragraph content in a mail merge field. * @memberof ApiParagraph - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiParagraph.prototype.WrapInMailMergeField = function(){}; +ApiParagraph.prototype.WrapInMailMergeField = function(){ return true; }; /** * Adds a numbered cross-reference to the current paragraph. * Please note that this paragraph must be in the document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {numberedRefTo} sRefType - The text or numeric value of a numbered reference you want to insert. * @param {ApiParagraph} oParaTo - The numbered paragraph to be referred to (must be in the document). * @param {boolean} [bLink=true] - Specifies if the reference will be inserted as a hyperlink. @@ -2926,7 +3606,6 @@ ApiParagraph.prototype.AddNumberedCrossRef = function(sRefTo, oParaTo, bLink, bA * Adds a heading cross-reference to the current paragraph. * Please note that this paragraph must be in the document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {headingRefTo} sRefType - The text or numeric value of a heading reference you want to insert. * @param {ApiParagraph} oParaTo - The heading paragraph to be referred to (must be in the document). * @param {boolean} [bLink=true] - Specifies if the reference will be inserted as a hyperlink. @@ -2939,8 +3618,7 @@ ApiParagraph.prototype.AddHeadingCrossRef = function(sRefTo, oParaTo, bLink, bAb * Adds a bookmark cross-reference to the current paragraph. * Please note that this paragraph must be in the document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] - * @param {bookmarkRefTo} sRefType - The text or numeric value of a bookmark reference you want to insert. + * @param {bookmarkRefTo} sRefTo - The text or numeric value of a bookmark reference you want to insert. * @param {string} sBookmarkName - The name of the bookmark to be referred to (must be in the document). * @param {boolean} [bLink=true] - Specifies if the reference will be inserted as a hyperlink. * @param {boolean} [bAboveBelow=false] - Specifies if the above/below words indicating the position of the reference should be included (don't used with the "text" and "aboveBelow" sRefType). @@ -2953,7 +3631,6 @@ ApiParagraph.prototype.AddBookmarkCrossRef = function(sRefTo, sBookmarkName, bLi * Adds a footnote cross-reference to the current paragraph. * Please note that this paragraph must be in the document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {footnoteRefTo} sRefType - The text or numeric value of a footnote reference you want to insert. * @param {ApiParagraph} oParaTo - The first paragraph from a footnote to be referred to (must be in the document). * @param {boolean} [bLink=true] - Specifies if the reference will be inserted as a hyperlink. @@ -2966,7 +3643,6 @@ ApiParagraph.prototype.AddFootnoteCrossRef = function(sRefTo, oParaTo, bLink, bA * Adds an endnote cross-reference to the current paragraph. * Please note that this paragraph must be in the document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {endnoteRefTo} sRefType - The text or numeric value of an endnote reference you want to insert. * @param {ApiParagraph} oParaTo - The first paragraph from an endnote to be referred to (must be in the document). * @param {boolean} [bLink=true] - Specifies if the reference will be inserted as a hyperlink. @@ -2979,7 +3655,6 @@ ApiParagraph.prototype.AddEndnoteCrossRef = function(sRefTo, oParaTo, bLink, bAb * Adds a caption cross-reference to the current paragraph. * Please note that this paragraph must be in the document. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {CaptionLabel | string} sCaption - The caption label ("Equation", "Figure", "Table", or another caption label). * @param {captionRefTo} sRefType - The text or numeric value of a caption reference you want to insert. * @param {ApiParagraph} oParaTo - The caption paragraph to be referred to (must be in the document). @@ -2992,7 +3667,6 @@ ApiParagraph.prototype.AddCaptionCrossRef = function(sCaption, sRefTo, oParaTo, /** * Converts the ApiParagraph object into the JSON object. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} @@ -3002,7 +3676,6 @@ ApiParagraph.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ return /** * Returns the paragraph position within its parent element. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {Number} - returns -1 if the paragraph parent doesn't exist. */ ApiParagraph.prototype.GetPosInParent = function(){ return 0; }; @@ -3010,7 +3683,6 @@ ApiParagraph.prototype.GetPosInParent = function(){ return 0; }; /** * Replaces the current paragraph with a new element. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {DocumentElement} oElement - The element to replace the current paragraph with. * @returns {boolean} */ @@ -3021,7 +3693,6 @@ ApiParagraph.prototype.ReplaceByElement = function(oElement){ return true; }; * Please note that the current paragraph must be in the document (not in the footer/header). * And if the current paragraph is placed in a shape, then a caption is added after (or before) the parent shape. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {string} sAdditional - The additional text. * @param {CaptionLabel | String} [sLabel="Table"] - The caption label. * @param {boolean} [bExludeLabel=false] - Specifies whether to exclude the label from the caption. @@ -3037,7 +3708,6 @@ ApiParagraph.prototype.AddCaption = function(sAdditional, sLabel, bExludeLabel, /** * Returns the paragraph section. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @returns {ApiSection} */ ApiParagraph.prototype.GetSection = function(){ return new ApiSection(); }; @@ -3045,7 +3715,6 @@ ApiParagraph.prototype.GetSection = function(){ return new ApiSection(); }; /** * Sets the specified section to the current paragraph. * @memberof ApiParagraph - * @typeofeditors ["CDE"] * @param {ApiSection} oSection - The section which will be set to the paragraph. * @returns {boolean} */ @@ -3054,7 +3723,6 @@ ApiParagraph.prototype.SetSection = function(oSection){ return true; }; /** * Returns a type of the ApiRun class. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"run"} */ ApiRun.prototype.GetClassType = function(){ return ""; }; @@ -3062,7 +3730,6 @@ ApiRun.prototype.GetClassType = function(){ return ""; }; /** * Returns the text properties of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiTextPr} */ ApiRun.prototype.GetTextPr = function(){ return new ApiTextPr(); }; @@ -3070,64 +3737,63 @@ ApiRun.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** * Clears the content from the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.ClearContent = function(){}; +ApiRun.prototype.ClearContent = function(){ return true; }; /** * Removes all the elements from the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.RemoveAllElements = function(){}; +ApiRun.prototype.RemoveAllElements = function(){ return true; }; /** * Deletes the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.Delete = function(){}; +ApiRun.prototype.Delete = function(){ return true; }; /** * Adds some text to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sText - The text which will be added to the current run. + * @returns {boolean} */ -ApiRun.prototype.AddText = function(sText){}; +ApiRun.prototype.AddText = function(sText){ return true; }; /** * Adds a page break and starts the next element from a new page. * @memberof ApiRun - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiRun.prototype.AddPageBreak = function(){}; +ApiRun.prototype.AddPageBreak = function(){ return true; }; /** * Adds a line break to the current run position and starts the next element from a new line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.AddLineBreak = function(){}; +ApiRun.prototype.AddLineBreak = function(){ return true; }; /** * Adds a column break to the current run position and starts the next element from a new column. * @memberof ApiRun - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiRun.prototype.AddColumnBreak = function(){}; +ApiRun.prototype.AddColumnBreak = function(){ return true; }; /** * Adds a tab stop to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] + * @returns {boolean} */ -ApiRun.prototype.AddTabStop = function(){}; +ApiRun.prototype.AddTabStop = function(){ return true; }; /** * Adds a drawing object (image, shape or chart) to the current text run. * @memberof ApiRun - * @typeofeditors ["CDE"] * @param {ApiDrawing} oDrawing - The object which will be added to the current run. * @returns {boolean} - returns false if param is invalid. */ @@ -3136,7 +3802,6 @@ ApiRun.prototype.AddDrawing = function(oDrawing){ return true; }; /** * Selects the current run. * @memberof ApiRun - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiRun.prototype.Select = function(){ return true; }; @@ -3144,7 +3809,6 @@ ApiRun.prototype.Select = function(){ return true; }; /** * Adds a hyperlink to the current run. * @memberof ApiRun - * @typeofeditors ["CDE"] * @param {string} sLink - The link address. * @param {string} sScreenTipText - The screen tip text. * @returns {ApiHyperlink | null} - returns false if params are invalid. @@ -3154,7 +3818,6 @@ ApiRun.prototype.AddHyperlink = function(sLink, sScreenTipText){ return new ApiH /** * Creates a copy of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {ApiRun} */ ApiRun.prototype.Copy = function(){ return new ApiRun(); }; @@ -3162,17 +3825,15 @@ ApiRun.prototype.Copy = function(){ return new ApiRun(); }; /** * Returns a Range object that represents the part of the document contained in the specified run. * @memberof ApiRun - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character in the current element. - * @param {Number} End - End character in the current element. + * @param {Number} Start - Start position index in the current element. + * @param {Number} End - End position index in the current element. * @returns {ApiRange} - * */ + */ ApiRun.prototype.GetRange = function(Start, End){ return new ApiRange(); }; /** * Returns a content control that contains the current run. * @memberof ApiRun - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt | ApiInlineLvlSdt | null} - returns null if parent content control doesn't exist. */ ApiRun.prototype.GetParentContentControl = function(){ return new ApiBlockLvlSdt(); }; @@ -3180,7 +3841,6 @@ ApiRun.prototype.GetParentContentControl = function(){ return new ApiBlockLvlSdt /** * Returns a table that contains the current run. * @memberof ApiRun - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null if parent table doesn't exist. */ ApiRun.prototype.GetParentTable = function(){ return new ApiTable(); }; @@ -3188,15 +3848,20 @@ ApiRun.prototype.GetParentTable = function(){ return new ApiTable(); }; /** * Returns a table cell that contains the current run. * @memberof ApiRun - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - returns null is parent cell doesn't exist. */ ApiRun.prototype.GetParentTableCell = function(){ return new ApiTableCell(); }; +/** + * Returns a parent paragraph of the current run. + * @memberof ApiRun + * @returns {ApiParagraph} + */ +ApiRun.prototype.GetParentParagraph = function(){ return new ApiParagraph(); }; + /** * Sets the text properties to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ApiTextPr} oTextPr - The text properties that will be set to the current run. * @returns {ApiTextPr} */ @@ -3205,7 +3870,6 @@ ApiRun.prototype.SetTextPr = function(oTextPr){ return new ApiTextPr(); }; /** * Sets the bold property to the text character. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isBold - Specifies that the contents of the current run are displayed bold. * @returns {ApiTextPr} */ @@ -3214,7 +3878,6 @@ ApiRun.prototype.SetBold = function(isBold){ return new ApiTextPr(); }; /** * Specifies that any lowercase characters in the current text run are formatted for display only as their capital letter character equivalents. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isCaps - Specifies that the contents of the current run are displayed capitalized. * @returns {ApiTextPr} */ @@ -3223,7 +3886,6 @@ ApiRun.prototype.SetCaps = function(isCaps){ return new ApiTextPr(); }; /** * Sets the text color for the current text run in the RGB format. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -3235,7 +3897,6 @@ ApiRun.prototype.SetColor = function(r, g, b, isAuto){ return new ApiTextPr(); } /** * Specifies that the contents of the current run are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isDoubleStrikeout - Specifies that the contents of the current run are displayed double struck through. * @returns {ApiTextPr} */ @@ -3244,7 +3905,6 @@ ApiRun.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return new Ap /** * Sets all 4 font slots with the specified font family. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sFontFamily - The font family or families used for the current text run. * @returns {ApiTextPr} */ @@ -3253,7 +3913,6 @@ ApiRun.prototype.SetFontFamily = function(sFontFamily){ return new ApiTextPr(); /** * Returns all font names from all elements inside the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {string[]} - The font names used for the current run. */ ApiRun.prototype.GetFontNames = function(){ return [""]; }; @@ -3261,7 +3920,6 @@ ApiRun.prototype.GetFontNames = function(){ return [""]; }; /** * Sets the font size to the characters of the current text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiTextPr} */ @@ -3270,7 +3928,6 @@ ApiRun.prototype.SetFontSize = function(nSize){ return new ApiTextPr(); }; /** * Specifies a highlighting color which is applied as a background to the contents of the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiTextPr} */ @@ -3279,7 +3936,6 @@ ApiRun.prototype.SetHighlight = function(sColor){ return new ApiTextPr(); }; /** * Sets the italic property to the text character. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isItalic - Specifies that the contents of the current run are displayed italicized. * @returns {ApiTextPr} */ @@ -3289,7 +3945,6 @@ ApiRun.prototype.SetItalic = function(isItalic){ return new ApiTextPr(); }; * Specifies the languages which will be used to check spelling and grammar (if requested) when processing * the contents of this text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sLangId - The possible value for this parameter is a language identifier as defined by * RFC 4646/BCP 47. Example: "en-CA". * @returns {ApiTextPr} @@ -3300,7 +3955,6 @@ ApiRun.prototype.SetLanguage = function(sLangId){ return new ApiTextPr(); }; * Specifies an amount by which text is raised or lowered for this run in relation to the default * baseline of the surrounding non-positioned text. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nPosition - Specifies a positive (raised text) or negative (lowered text) * measurement in half-points (1/144 of an inch). * @returns {ApiTextPr} @@ -3310,7 +3964,6 @@ ApiRun.prototype.SetPosition = function(nPosition){ return new ApiTextPr(); }; /** * Specifies the shading applied to the contents of the current text run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ShdType} sType - The shading type applied to the contents of the current text run. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. @@ -3323,7 +3976,6 @@ ApiRun.prototype.SetShd = function(sType, r, g, b){ return new ApiTextPr(); }; * Specifies that all the small letter characters in this text run are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current run are displayed capitalized two points smaller or not. * @returns {ApiTextPr} */ @@ -3332,7 +3984,6 @@ ApiRun.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiTextPr(); } /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiTextPr} */ @@ -3341,7 +3992,6 @@ ApiRun.prototype.SetSpacing = function(nSpacing){ return new ApiTextPr(); }; /** * Specifies that the contents of the current run are displayed with a single horizontal line through the center of the line. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isStrikeout - Specifies that the contents of the current run are displayed struck through. * @returns {ApiTextPr} */ @@ -3350,7 +4000,6 @@ ApiRun.prototype.SetStrikeout = function(isStrikeout){ return new ApiTextPr(); } /** * Sets a style to the current run. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {ApiStyle} oStyle - The style which must be applied to the text run. * @returns {ApiTextPr} */ @@ -3360,7 +4009,6 @@ ApiRun.prototype.SetStyle = function(oStyle){ return new ApiTextPr(); }; * Specifies that the contents of the current run are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isUnderline - Specifies that the contents of the current run are displayed underlined. * @returns {ApiTextPr} */ @@ -3368,11 +4016,10 @@ ApiRun.prototype.SetUnderline = function(isUnderline){ return new ApiTextPr(); } /** * Specifies the alignment which will be applied to the contents of the current run in relation to the default appearance of the text run: - * * "baseline" - the characters in the current text run will be aligned by the default text baseline. - * * "subscript" - the characters in the current text run will be aligned below the default text baseline. - * * "superscript" - the characters in the current text run will be aligned above the default text baseline. + * "baseline" - the characters in the current text run will be aligned by the default text baseline. + * "subscript" - the characters in the current text run will be aligned below the default text baseline. + * "superscript" - the characters in the current text run will be aligned above the default text baseline. * @memberof ApiRun - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiTextPr} */ @@ -3381,14 +4028,13 @@ ApiRun.prototype.SetVertAlign = function(sType){ return new ApiTextPr(); }; /** * Wraps a run in a mail merge field. * @memberof ApiRun - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiRun.prototype.WrapInMailMergeField = function(){}; +ApiRun.prototype.WrapInMailMergeField = function(){ return true; }; /** * Converts the ApiRun object into the JSON object. * @memberof ApiRun - * @typeofeditors ["CDE"] * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} */ @@ -3398,10 +4044,9 @@ ApiRun.prototype.ToJSON = function(bWriteStyles){ return new JSON(); }; * Adds a comment to the current run. * Please note that this run must be in the document. * @memberof ApiRun - * @typeofeditors ["CDE"] - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). + * @param {string} sText - The comment text. + * @param {string} [sAuthor] - The author's name. + * @param {string} [sUserId] - The user ID of the comment author. * @returns {ApiComment} - Returns null if the comment was not added. */ ApiRun.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; @@ -3410,73 +4055,93 @@ ApiRun.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiC * Returns a text from the text run. * @memberof ApiRun * @param {object} oPr - The resulting string display properties. - * @param {string} [oPr.NewLineSeparator='\r'] - Defines how the line separator will be specified in the resulting string. - * @param {string} [oPr.TabSymbol='\t'] - Defines how the tab will be specified in the resulting string. - * @typeofeditors ["CDE"] + * @param {string} [oPr.NewLineSeparator='\r'] - Defines how the line separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r". + * @param {string} [oPr.TabSymbol='\t'] - Defines how the tab will be specified in the resulting string. Any symbol can be used. The default symbol is "\t". * @returns {string} */ ApiRun.prototype.GetText = function(oPr){ return ""; }; +/** + * Moves a cursor to a specified position of the current text run. + * If the current run is not assigned to any document part, then false is returned. Otherwise, this method returns true. + * If there is any selection in the document, it will be removed. + * @memberof ApiRun + * @param {number} [nPos=0] - Desired cursor position. + * @returns {boolean} + * @since 8.2.0 + */ +ApiRun.prototype.MoveCursorToPos = function(nPos){ return true; }; + /** * Returns a type of the ApiSection class. * @memberof ApiSection - * @typeofeditors ["CDE"] * @returns {"section"} */ ApiSection.prototype.GetClassType = function(){ return ""; }; /** - * Specifies a type of the current section. The section type defines how the contents of the current - * section are placed relative to the previous section.
+ * The section break type which defines how the contents of the current section are placed relative to the previous section. * WordprocessingML supports five distinct types of section breaks: - * * Next page section breaks (the default if type is not specified), which begin the new section on the - * following page. - * * Odd page section breaks, which begin the new section on the next odd-numbered page. - * * Even page section breaks, which begin the new section on the next even-numbered page. - * * Continuous section breaks, which begin the new section on the following paragraph. This means that - * continuous section breaks might not specify certain page-level section properties, since they shall be - * inherited from the following section. These breaks, however, can specify other section properties, such - * as line numbering and footnote/endnote settings. - * * Column section breaks, which begin the new section on the next column on the page. + * Next page ("nextPage") - starts a new section on the next page (the default value). + * Odd ("oddPage") - starts a new section on the next odd-numbered page. + * Even ("evenPage") - starts a new section on the next even-numbered page. + * Continuous ("continuous") - starts a new section in the next paragraph. + * This means that continuous section breaks might not specify certain page-level section properties, + * since they shall be inherited from the following section. + * However, these breaks can specify other section properties, such as line numbering and footnote/endnote settings. + * Column ("nextColumn") - starts a new section in the next column on the page. + * @typedef {("nextPage" | "oddPage" | "evenPage" | "continuous" | "nextColumn")} SectionBreakType +*/ + +/** + * Specifies a type of the current section. The section type defines how the contents of the current + * section are placed relative to the previous section. * @memberof ApiSection - * @typeofeditors ["CDE"] - * @param {("nextPage" | "oddPage" | "evenPage" | "continuous" | "nextColumn")} sType - The section break type. + * @param {SectionBreakType} sType - The section break type. + * @returns {boolean} */ -ApiSection.prototype.SetType = function(sType){}; +ApiSection.prototype.SetType = function(sType){ return true; }; + +/** + * Returns the section break type. + * @memberof ApiSection + * @returns {SectionBreakType} - The section break type. + * @since 8.2.0 + */ +ApiSection.prototype.GetType = function(){ return new SectionBreakType(); }; /** * Specifies that all the text columns in the current section are of equal width. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {number} nCount - Number of columns. * @param {twips} nSpace - Distance between columns measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiSection.prototype.SetEqualColumns = function(nCount, nSpace){}; +ApiSection.prototype.SetEqualColumns = function(nCount, nSpace){ return true; }; /** * Specifies that all the columns in the current section have the different widths. Number of columns is equal * to the length of the aWidth array. The length of the aSpaces array MUST BE equal to (aWidth.length - 1). * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {twips[]} aWidths - An array of column width values measured in twentieths of a point (1/1440 of an inch). * @param {twips[]} aSpaces - An array of distance values between the columns measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiSection.prototype.SetNotEqualColumns = function(aWidths, aSpaces){}; +ApiSection.prototype.SetNotEqualColumns = function(aWidths, aSpaces){ return true; }; /** * Specifies the properties (size and orientation) for all the pages in the current section. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {twips} nWidth - The page width measured in twentieths of a point (1/1440 of an inch). * @param {twips} nHeight - The page height measured in twentieths of a point (1/1440 of an inch). * @param {boolean} [isPortrait=false] - Specifies the orientation of all the pages in this section (if set to true, then the portrait orientation is chosen). + * @returns {boolean} */ -ApiSection.prototype.SetPageSize = function(nWidth, nHeight, isPortrait){}; +ApiSection.prototype.SetPageSize = function(nWidth, nHeight, isPortrait){ return true; }; /** * Gets page height for current section. * @memberof ApiSection - * @typeofeditors ["CDE"] * @returns {twips} */ ApiSection.prototype.GetPageHeight = function(){ return new twips(); }; @@ -3484,7 +4149,6 @@ ApiSection.prototype.GetPageHeight = function(){ return new twips(); }; /** * Gets page width for current section. * @memberof ApiSection - * @typeofeditors ["CDE"] * @returns {twips} */ ApiSection.prototype.GetPageWidth = function(){ return new twips(); }; @@ -3492,35 +4156,34 @@ ApiSection.prototype.GetPageWidth = function(){ return new twips(); }; /** * Specifies the page margins for all the pages in this section. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {twips} nLeft - The left margin width measured in twentieths of a point (1/1440 of an inch). * @param {twips} nTop - The top margin height measured in twentieths of a point (1/1440 of an inch). * @param {twips} nRight - The right margin width measured in twentieths of a point (1/1440 of an inch). * @param {twips} nBottom - The bottom margin height measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiSection.prototype.SetPageMargins = function(nLeft, nTop, nRight, nBottom){}; +ApiSection.prototype.SetPageMargins = function(nLeft, nTop, nRight, nBottom){ return true; }; /** * Specifies the distance from the top edge of the page to the top edge of the header. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {twips} nDistance - The distance from the top edge of the page to the top edge of the header measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiSection.prototype.SetHeaderDistance = function(nDistance){}; +ApiSection.prototype.SetHeaderDistance = function(nDistance){ return true; }; /** * Specifies the distance from the bottom edge of the page to the bottom edge of the footer. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {twips} nDistance - The distance from the bottom edge of the page to the bottom edge of the footer measured * in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiSection.prototype.SetFooterDistance = function(nDistance){}; +ApiSection.prototype.SetFooterDistance = function(nDistance){ return true; }; /** * Returns the content for the specified header type. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {HdrFtrType} sType - Header type to get the content from. * @param {boolean} [isCreate=false] - Specifies whether to create a new header or not with the specified header type in case * no header with such a type could be found in the current section. @@ -3532,15 +4195,14 @@ ApiSection.prototype.GetHeader = function(sType, isCreate){ return new ApiDocume * Removes the header of the specified type from the current section. After removal, the header will be inherited from * the previous section, or if this is the first section in the document, no header of the specified type will be presented. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {HdrFtrType} sType - Header type to be removed. + * @returns {boolean} */ -ApiSection.prototype.RemoveHeader = function(sType){}; +ApiSection.prototype.RemoveHeader = function(sType){ return true; }; /** * Returns the content for the specified footer type. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {HdrFtrType} sType - Footer type to get the content from. * @param {boolean} [isCreate=false] - Specifies whether to create a new footer or not with the specified footer type in case * no footer with such a type could be found in the current section. @@ -3552,23 +4214,22 @@ ApiSection.prototype.GetFooter = function(sType, isCreate){ return new ApiDocume * Removes the footer of the specified type from the current section. After removal, the footer will be inherited from * the previous section, or if this is the first section in the document, no footer of the specified type will be presented. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {HdrFtrType} sType - Footer type to be removed. + * @returns {boolean} */ -ApiSection.prototype.RemoveFooter = function(sType){}; +ApiSection.prototype.RemoveFooter = function(sType){ return true; }; /** * Specifies whether the current section in this document has the different header and footer for the section first page. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {boolean} isTitlePage - If true, the first page of the section will have header and footer that will differ from the other pages of the same section. + * @returns {boolean} */ -ApiSection.prototype.SetTitlePage = function(isTitlePage){}; +ApiSection.prototype.SetTitlePage = function(isTitlePage){ return true; }; /** * Returns the next section if exists. * @memberof ApiSection - * @typeofeditors ["CDE"] * @returns {ApiSection | null} - returns null if section is last. */ ApiSection.prototype.GetNext = function(){ return new ApiSection(); }; @@ -3576,7 +4237,6 @@ ApiSection.prototype.GetNext = function(){ return new ApiSection(); }; /** * Returns the previous section if exists. * @memberof ApiSection - * @typeofeditors ["CDE"] * @returns {ApiSection | null} - returns null if section is first. */ ApiSection.prototype.GetPrevious = function(){ return new ApiSection(); }; @@ -3584,17 +4244,32 @@ ApiSection.prototype.GetPrevious = function(){ return new ApiSection(); }; /** * Converts the ApiSection object into the JSON object. * @memberof ApiSection - * @typeofeditors ["CDE"] * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} */ ApiSection.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ return new JSON(); }; +/** + * Sets the start page number for the specified section. + * @memberof ApiSection + * @param {number} nStartNumber - The start page number. + * @returns {boolean} + * @since 8.3.0 + */ +ApiSection.prototype.SetStartPageNumber = function(nStartNumber){ return true; }; + +/** + * Returns the start page number of the specified section. + * @memberof ApiSection + * @returns {number} + * @since 8.3.0 + */ +ApiSection.prototype.GetStartPageNumber = function(){ return 0; }; + /** * Returns a type of the ApiTable class. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {"table"} */ ApiTable.prototype.GetClassType = function(){ return ""; }; @@ -3602,7 +4277,6 @@ ApiTable.prototype.GetClassType = function(){ return ""; }; /** * Returns a number of rows in the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {number} */ ApiTable.prototype.GetRowsCount = function(){ return 0; }; @@ -3610,7 +4284,6 @@ ApiTable.prototype.GetRowsCount = function(){ return 0; }; /** * Returns a table row by its position in the table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {number} nPos - The row position within the table. * @returns {ApiTableRow | null} - returns null if param is invalid. */ @@ -3619,7 +4292,6 @@ ApiTable.prototype.GetRow = function(nPos){ return new ApiTableRow(); }; /** * Returns a cell by its position. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {number} nRow - The row position in the current table where the specified cell is placed. * @param {number} nCell - The cell position in the current table. * @returns {ApiTableCell | null} - returns null if params are invalid. @@ -3630,7 +4302,6 @@ ApiTable.prototype.GetCell = function(nRow, nCell){ return new ApiTableCell(); } * Merges an array of cells. If the merge is done successfully, it will return the resulting merged cell, otherwise the result will be "null". * The number of cells in any row and the number of rows in the current table may be changed. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell[]} aCells - The array of cells to be merged. * @returns {ApiTableCell} */ @@ -3639,7 +4310,6 @@ ApiTable.prototype.MergeCells = function(aCells){ return new ApiTableCell(); }; /** * Sets a style to the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiStyle} oStyle - The style which will be applied to the current table. * @returns {boolean} - returns false if param is invalid. */ @@ -3654,20 +4324,19 @@ ApiTable.prototype.SetStyle = function(oStyle){ return true; }; * The default setting is to apply the row and column band formatting, but not the first row, last row, first * column, or last column formatting. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {boolean} isFirstColumn - Specifies that the first column conditional formatting will be applied to the table. * @param {boolean} isFirstRow - Specifies that the first row conditional formatting will be applied to the table. * @param {boolean} isLastColumn - Specifies that the last column conditional formatting will be applied to the table. * @param {boolean} isLastRow - Specifies that the last row conditional formatting will be applied to the table. * @param {boolean} isHorBand - Specifies that the horizontal band conditional formatting will not be applied to the table. * @param {boolean} isVerBand - Specifies that the vertical band conditional formatting will not be applied to the table. + * @returns {boolean} */ -ApiTable.prototype.SetTableLook = function(isFirstColumn, isFirstRow, isLastColumn, isLastRow, isHorBand, isVerBand){}; +ApiTable.prototype.SetTableLook = function(isFirstColumn, isFirstRow, isLastColumn, isLastRow, isHorBand, isVerBand){ return true; }; /** * Splits the cell into a given number of rows and columns. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell} [oCell] - The cell which will be split. * @param {Number} [nRow=1] - Count of rows into which the cell will be split. * @param {Number} [nCol=1] - Count of columns into which the cell will be split. @@ -3678,7 +4347,6 @@ ApiTable.prototype.Split = function(oCell, nRow, nCol){ return new ApiTable(); } /** * Adds a new row to the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell} [oCell] - The cell after which a new row will be added. If not specified, a new row will * be added at the end of the table. * @param {boolean} [isBefore=false] - Adds a new row before (false) or after (true) the specified cell. If no cell is specified, then @@ -3690,7 +4358,6 @@ ApiTable.prototype.AddRow = function(oCell, isBefore){ return new ApiTableRow(); /** * Adds the new rows to the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell} [oCell] - The cell after which the new rows will be added. If not specified, the new rows will * be added at the end of the table. * @param {Number} nCount - Count of rows to be added. @@ -3703,38 +4370,37 @@ ApiTable.prototype.AddRows = function(oCell, nCount, isBefore){ return new ApiTa /** * Adds a new column to the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell} [oCell] - The cell after which a new column will be added. If not specified, a new column will be added at the end of the table. * @param {boolean} [isBefore=false] - Adds a new column before (false) or after (true) the specified cell. If no cell is specified, * then this parameter will be ignored. + * @returns {boolean} */ -ApiTable.prototype.AddColumn = function(oCell, isBefore){}; +ApiTable.prototype.AddColumn = function(oCell, isBefore){ return true; }; /** * Adds the new columns to the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell} [oCell] - The cell after which the new columns will be added. If not specified, the new columns will be added at the end of the table. * @param {Number} nCount - Count of columns to be added. * @param {boolean} [isBefore=false] - Adds the new columns before (false) or after (true) the specified cell. If no cell is specified, * then this parameter will be ignored. + * @returns {ApiTable} */ -ApiTable.prototype.AddColumns = function(oCell, nCount, isBefore){}; +ApiTable.prototype.AddColumns = function(oCell, nCount, isBefore){ return new ApiTable(); }; /** * Adds a paragraph or a table or a blockLvl content control using its position in the cell. * @memberof ApiTable - * @typeofeditors ["CDE", "CPE"] * @param {ApiTableCell} oCell - The cell where the specified element will be added. * @param {number} nPos - The position in the cell where the specified element will be added. * @param {DocumentElement} oElement - The document element which will be added at the current position. + * @returns {boolean} */ -ApiTable.prototype.AddElement = function(oCell, nPos, oElement){}; +ApiTable.prototype.AddElement = function(oCell, nPos, oElement){ return true; }; /** * Removes a table row with a specified cell. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell} oCell - The cell which is placed in the row that will be removed. * @returns {boolean} Is the table empty after removing. */ @@ -3743,7 +4409,6 @@ ApiTable.prototype.RemoveRow = function(oCell){ return true; }; /** * Removes a table column with a specified cell. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTableCell} oCell - The cell which is placed in the column that will be removed. * @returns {boolean} Is the table empty after removing. */ @@ -3752,7 +4417,6 @@ ApiTable.prototype.RemoveColumn = function(oCell){ return true; }; /** * Creates a copy of the current table. * @memberof ApiTable - * @typeofeditors ["CDE", "CPE"] * @returns {ApiTable} */ ApiTable.prototype.Copy = function(){ return new ApiTable(); }; @@ -3760,7 +4424,6 @@ ApiTable.prototype.Copy = function(){ return new ApiTable(); }; /** * Selects the current table. * @memberof ApiTable - * @typeofeditors ["CDE", "CPE"] * @returns {boolean} */ ApiTable.prototype.Select = function(){ return true; }; @@ -3768,56 +4431,50 @@ ApiTable.prototype.Select = function(){ return true; }; /** * Returns a Range object that represents the part of the document contained in the specified table. * @memberof ApiTable - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character in the current element. - * @param {Number} End - End character in the current element. + * @param {Number} Start - Start position index in the current element. + * @param {Number} End - End position index in the current element. * @returns {ApiRange} - * */ + */ ApiTable.prototype.GetRange = function(Start, End){ return new ApiRange(); }; /** * Sets the horizontal alignment to the table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {String} sType - Horizontal alignment type: may be "left" or "center" or "right". * @returns {boolean} - returns false if param is invalid. - * */ + */ ApiTable.prototype.SetHAlign = function(sType){ return true; }; /** * Sets the vertical alignment to the table. - * @typeofeditors ["CDE"] * @param {String} sType - Vertical alignment type: may be "top" or "center" or "bottom". * @returns {boolean} - returns false if param is invalid. - * */ + */ ApiTable.prototype.SetVAlign = function(sType){ return true; }; /** * Sets the table paddings. * If table is inline, then only left padding is applied. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {Number} nLeft - Left padding. * @param {Number} nTop - Top padding. * @param {Number} nRight - Right padding. * @param {Number} nBottom - Bottom padding. * @returns {boolean} - returns true. - * */ + */ ApiTable.prototype.SetPaddings = function(nLeft, nTop, nRight, nBottom){ return true; }; /** * Sets the table wrapping style. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {boolean} isFlow - Specifies if the table is inline or not. * @returns {boolean} - returns false if param is invalid. - * */ + */ ApiTable.prototype.SetWrappingStyle = function(isFlow){ return true; }; /** * Returns a content control that contains the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt | null} - return null is parent content control doesn't exist. */ ApiTable.prototype.GetParentContentControl = function(){ return new ApiBlockLvlSdt(); }; @@ -3825,7 +4482,6 @@ ApiTable.prototype.GetParentContentControl = function(){ return new ApiBlockLvlS /** * Wraps the current table object with a content control. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {number} nType - Defines if this method returns the ApiBlockLvlSdt (nType === 1) or ApiTable (any value except 1) object. * @returns {ApiTable | ApiBlockLvlSdt} */ @@ -3834,39 +4490,20 @@ ApiTable.prototype.InsertInContentControl = function(nType){ return new ApiTable /** * Returns a table that contains the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null if parent table doesn't exist. */ ApiTable.prototype.GetParentTable = function(){ return new ApiTable(); }; /** - * Returns the tables that contain the current table. + * Returns an array of tables that represents all the tables nested within the specified table. * @memberof ApiTable - * @typeofeditors ["CDE"] - * @returns {ApiTable[]} + * @returns {ApiTable[]} */ ApiTable.prototype.GetTables = function(){ return [new ApiTable()]; }; -/** - * Returns the next table if exists. - * @memberof ApiTable - * @typeofeditors ["CDE"] - * @returns {ApiTable | null} - returns null if table is last. - */ -ApiTable.prototype.GetNext = function(){ return new ApiTable(); }; - -/** - * Returns the previous table if exists. - * @memberof ApiTable - * @typeofeditors ["CDE"] - * @returns {ApiTable | null} - returns null if table is first. - */ -ApiTable.prototype.GetPrevious = function(){ return new ApiTable(); }; - /** * Returns a table cell that contains the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - returns null if parent cell doesn't exist. */ ApiTable.prototype.GetParentTableCell = function(){ return new ApiTableCell(); }; @@ -3874,7 +4511,6 @@ ApiTable.prototype.GetParentTableCell = function(){ return new ApiTableCell(); } /** * Deletes the current table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {boolean} - returns false if parent of table doesn't exist. */ ApiTable.prototype.Delete = function(){ return true; }; @@ -3882,7 +4518,6 @@ ApiTable.prototype.Delete = function(){ return true; }; /** * Clears the content from the table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {boolean} - returns true. */ ApiTable.prototype.Clear = function(){ return true; }; @@ -3890,7 +4525,6 @@ ApiTable.prototype.Clear = function(){ return true; }; /** * Searches for a scope of a table object. The search results are a collection of ApiRange objects. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {string} sText - Search string. * @param {boolean} isMatchCase - Case sensitive or not. * @returns {ApiRange[]} @@ -3900,7 +4534,6 @@ ApiTable.prototype.Search = function(sText, isMatchCase){ return [new ApiRange() /** * Applies the text settings to the entire contents of the table. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {ApiTextPr} oTextPr - The text properties that will be set to the current table. * @returns {boolean} - returns true. */ @@ -3913,7 +4546,6 @@ ApiTable.prototype.SetTextPr = function(oTextPr){ return true; }; * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} bNone - Defines that background color will not be set. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiTable.prototype.SetBackgroundColor = function(r, g, b, bNone){ return true; }; @@ -3921,7 +4553,6 @@ ApiTable.prototype.SetBackgroundColor = function(r, g, b, bNone){ return true; } /** * Converts the ApiTable object into the JSON object. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} @@ -3931,7 +4562,6 @@ ApiTable.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ return new /** * Returns the table position within its parent element. * @memberof ApiTable - * @typeofeditors ["CDE"] * @returns {Number} - returns -1 if the table parent doesn't exist. */ ApiTable.prototype.GetPosInParent = function(){ return 0; }; @@ -3939,7 +4569,6 @@ ApiTable.prototype.GetPosInParent = function(){ return 0; }; /** * Replaces the current table with a new element. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {DocumentElement} oElement - The element to replace the current table with. * @returns {boolean} */ @@ -3949,10 +4578,9 @@ ApiTable.prototype.ReplaceByElement = function(oElement){ return true; }; * Adds a comment to all contents of the current table. * Please note that this table must be in the document. * @memberof ApiTable - * @typeofeditors ["CDE"] - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). + * @param {string} sText - The comment text. + * @param {string} [sAuthor] - The author's name. + * @param {string} [sUserId] - The user ID of the comment author. * @returns {ApiComment} - Returns null if the comment was not added. */ ApiTable.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; @@ -3962,7 +4590,6 @@ ApiTable.prototype.AddComment = function(sText, sAuthor, sUserId){ return new Ap * Please note that the current table must be in the document (not in the footer/header). * And if the current table is placed in a shape, then a caption is added after (or before) the parent shape. * @memberof ApiTable - * @typeofeditors ["CDE"] * @param {string} sAdditional - The additional text. * @param {CaptionLabel | String} [sLabel="Table"] - The caption label. * @param {boolean} [bExludeLabel=false] - Specifies whether to exclude the label from the caption. @@ -3978,7 +4605,6 @@ ApiTable.prototype.AddCaption = function(sAdditional, sLabel, bExludeLabel, sNum /** * Returns a type of the ApiTableRow class. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {"tableRow"} */ ApiTableRow.prototype.GetClassType = function(){ return ""; }; @@ -3986,7 +4612,6 @@ ApiTableRow.prototype.GetClassType = function(){ return ""; }; /** * Returns a number of cells in the current row. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {number} */ ApiTableRow.prototype.GetCellsCount = function(){ return 0; }; @@ -3994,7 +4619,6 @@ ApiTableRow.prototype.GetCellsCount = function(){ return 0; }; /** * Returns a cell by its position. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @param {number} nPos - The cell position in the current row. * @returns {ApiTableCell} */ @@ -4003,7 +4627,6 @@ ApiTableRow.prototype.GetCell = function(nPos){ return new ApiTableCell(); }; /** * Returns the current row index. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {Number} */ ApiTableRow.prototype.GetIndex = function(){ return 0; }; @@ -4011,7 +4634,6 @@ ApiTableRow.prototype.GetIndex = function(){ return 0; }; /** * Returns the parent table of the current row. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null if parent table doesn't exist. */ ApiTableRow.prototype.GetParentTable = function(){ return new ApiTable(); }; @@ -4019,7 +4641,6 @@ ApiTableRow.prototype.GetParentTable = function(){ return new ApiTable(); }; /** * Returns the next row if exists. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {ApiTableRow | null} - returns null if row is last. */ ApiTableRow.prototype.GetNext = function(){ return new ApiTableRow(); }; @@ -4027,7 +4648,6 @@ ApiTableRow.prototype.GetNext = function(){ return new ApiTableRow(); }; /** * Returns the previous row if exists. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {ApiTableRow | null} - returns null if row is first. */ ApiTableRow.prototype.GetPrevious = function(){ return new ApiTableRow(); }; @@ -4035,7 +4655,6 @@ ApiTableRow.prototype.GetPrevious = function(){ return new ApiTableRow(); }; /** * Adds the new rows to the current table. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @param {Number} nCount - Count of rows to be added. * @param {boolean} [isBefore=false] - Specifies if the rows will be added before or after the current row. * @returns {ApiTable | null} - returns null if parent table doesn't exist. @@ -4045,7 +4664,6 @@ ApiTableRow.prototype.AddRows = function(nCount, isBefore){ return new ApiTable( /** * Merges the cells in the current row. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - return null if can't merge. */ ApiTableRow.prototype.MergeCells = function(){ return new ApiTableCell(); }; @@ -4053,7 +4671,6 @@ ApiTableRow.prototype.MergeCells = function(){ return new ApiTableCell(); }; /** * Clears the content from the current row. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {boolean} - returns false if parent table doesn't exist. */ ApiTableRow.prototype.Clear = function(){ return true; }; @@ -4061,7 +4678,6 @@ ApiTableRow.prototype.Clear = function(){ return true; }; /** * Removes the current table row. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @returns {boolean} - return false if parent table doesn't exist. */ ApiTableRow.prototype.Remove = function(){ return true; }; @@ -4069,7 +4685,6 @@ ApiTableRow.prototype.Remove = function(){ return true; }; /** * Sets the text properties to the current row. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @param {ApiTextPr} oTextPr - The text properties that will be set to the current row. * @returns {boolean} - returns false if parent table doesn't exist or param is invalid. */ @@ -4078,7 +4693,6 @@ ApiTableRow.prototype.SetTextPr = function(oTextPr){ return true; }; /** * Searches for a scope of a table row object. The search results are a collection of ApiRange objects. * @memberof ApiTableRow - * @typeofeditors ["CDE"] * @param {string} sText - Search string. * @param {boolean} isMatchCase - Case sensitive or not. * @returns {ApiRange[]} @@ -4092,7 +4706,6 @@ ApiTableRow.prototype.Search = function(sText, isMatchCase){ return [new ApiRang * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} bNone - Defines that background color will not be set. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiTableRow.prototype.SetBackgroundColor = function(r, g, b, bNone){ return true; }; @@ -4100,7 +4713,6 @@ ApiTableRow.prototype.SetBackgroundColor = function(r, g, b, bNone){ return true /** * Returns a type of the ApiTableCell class. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {"tableCell"} */ ApiTableCell.prototype.GetClassType = function(){ return ""; }; @@ -4108,7 +4720,6 @@ ApiTableCell.prototype.GetClassType = function(){ return ""; }; /** * Returns the current cell content. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {ApiDocumentContent} */ ApiTableCell.prototype.GetContent = function(){ return new ApiDocumentContent(); }; @@ -4116,7 +4727,6 @@ ApiTableCell.prototype.GetContent = function(){ return new ApiDocumentContent(); /** * Returns the current cell index. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {Number} */ ApiTableCell.prototype.GetIndex = function(){ return 0; }; @@ -4124,7 +4734,6 @@ ApiTableCell.prototype.GetIndex = function(){ return 0; }; /** * Returns an index of the parent row. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {number} */ ApiTableCell.prototype.GetRowIndex = function(){ return 0; }; @@ -4132,7 +4741,6 @@ ApiTableCell.prototype.GetRowIndex = function(){ return 0; }; /** * Returns a parent row of the current cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {ApiTableRow | null} - returns null if parent row doesn't exist. */ ApiTableCell.prototype.GetParentRow = function(){ return new ApiTableRow(); }; @@ -4140,7 +4748,6 @@ ApiTableCell.prototype.GetParentRow = function(){ return new ApiTableRow(); }; /** * Returns a parent table of the current cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null if parent table doesn't exist. */ ApiTableCell.prototype.GetParentTable = function(){ return new ApiTable(); }; @@ -4148,7 +4755,6 @@ ApiTableCell.prototype.GetParentTable = function(){ return new ApiTable(); }; /** * Adds the new rows to the current table. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @param {Number} nCount - Count of rows to be added. * @param {boolean} [isBefore=false] - Specifies if the new rows will be added before or after the current cell. * @returns {ApiTable | null} - returns null if parent table doesn't exist. @@ -4158,7 +4764,6 @@ ApiTableCell.prototype.AddRows = function(nCount, isBefore){ return new ApiTable /** * Adds the new columns to the current table. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @param {Number} nCount - Count of columns to be added. * @param {boolean} [isBefore=false] - Specifies if the new columns will be added before or after the current cell. * @returns {ApiTable | null} - returns null if parent table doesn't exist. @@ -4168,15 +4773,13 @@ ApiTableCell.prototype.AddColumns = function(nCount, isBefore){ return new ApiTa /** * Removes a column containing the current cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] - * @returns {bool | null} Is the table empty after removing. Returns null if parent table doesn't exist. + * @returns {boolean} - returns false if table doen't exist */ ApiTableCell.prototype.RemoveColumn = function(){ return true; }; /** * Removes a row containing the current cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {boolean} Is the table empty after removing. */ ApiTableCell.prototype.RemoveRow = function(){ return true; }; @@ -4184,7 +4787,6 @@ ApiTableCell.prototype.RemoveRow = function(){ return true; }; /** * Searches for a scope of a table cell object. The search results are a collection of ApiRange objects. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @param {string} sText - Search string. * @param {boolean} isMatchCase - Case sensitive or not. * @returns {ApiRange[]} @@ -4194,7 +4796,6 @@ ApiTableCell.prototype.Search = function(sText, isMatchCase){ return [new ApiRan /** * Returns the next cell if exists. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - returns null if cell is last. */ ApiTableCell.prototype.GetNext = function(){ return new ApiTableCell(); }; @@ -4202,7 +4803,6 @@ ApiTableCell.prototype.GetNext = function(){ return new ApiTableCell(); }; /** * Returns the previous cell if exists. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - returns null is cell is first. */ ApiTableCell.prototype.GetPrevious = function(){ return new ApiTableCell(); }; @@ -4210,7 +4810,6 @@ ApiTableCell.prototype.GetPrevious = function(){ return new ApiTableCell(); }; /** * Splits the cell into a given number of rows and columns. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @param {Number} [nRow=1] - Count of rows into which the cell will be split. * @param {Number} [nCol=1] - Count of columns into which the cell will be split. * @returns {ApiTable | null} - returns null if parent table doesn't exist. @@ -4220,7 +4819,6 @@ ApiTableCell.prototype.Split = function(nRow, nCol){ return new ApiTable(); }; /** * Sets the cell properties to the current cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @param {ApiTableCellPr} oApiTableCellPr - The properties that will be set to the current table cell. * @returns {boolean} - returns false if param is invalid. */ @@ -4229,7 +4827,6 @@ ApiTableCell.prototype.SetCellPr = function(oApiTableCellPr){ return true; }; /** * Applies the text settings to the entire contents of the current cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @param {ApiTextPr} oTextPr - The properties that will be set to the current table cell text. * @returns {boolean} - returns false if param is invalid. */ @@ -4238,7 +4835,6 @@ ApiTableCell.prototype.SetTextPr = function(oTextPr){ return true; }; /** * Clears the content from the current cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @returns {boolean} - returns false if parent row is invalid. */ ApiTableCell.prototype.Clear = function(){ return true; }; @@ -4246,7 +4842,6 @@ ApiTableCell.prototype.Clear = function(){ return true; }; /** * Adds a paragraph or a table or a blockLvl content control using its position in the cell. * @memberof ApiTableCell - * @typeofeditors ["CDE"] * @param {number} nPos - The position where the current element will be added. * @param {DocumentElement} oElement - The document element which will be added at the current position. * @returns {boolean} - returns false if oElement is invalid. @@ -4260,7 +4855,6 @@ ApiTableCell.prototype.AddElement = function(nPos, oElement){ return true; }; * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} bNone - Defines that background color will not be set. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiTableCell.prototype.SetBackgroundColor = function(r, g, b, bNone){ return true; }; @@ -4272,7 +4866,6 @@ ApiTableCell.prototype.SetBackgroundColor = function(r, g, b, bNone){ return tru * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} bNone - Defines that background color will not be set. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiTableCell.prototype.SetColumnBackgroundColor = function(r, g, b, bNone){ return true; }; @@ -4280,7 +4873,6 @@ ApiTableCell.prototype.SetColumnBackgroundColor = function(r, g, b, bNone){ retu /** * Returns a type of the ApiStyle class. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {"style"} */ ApiStyle.prototype.GetClassType = function(){ return ""; }; @@ -4288,7 +4880,6 @@ ApiStyle.prototype.GetClassType = function(){ return ""; }; /** * Returns a name of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {string} */ ApiStyle.prototype.GetName = function(){ return ""; }; @@ -4296,15 +4887,14 @@ ApiStyle.prototype.GetName = function(){ return ""; }; /** * Sets a name of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @param {string} sStyleName - The name which will be used for the current style. + * @returns {boolean} */ -ApiStyle.prototype.SetName = function(sStyleName){}; +ApiStyle.prototype.SetName = function(sStyleName){ return true; }; /** * Returns a type of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {StyleType} */ ApiStyle.prototype.GetType = function(){ return new StyleType(); }; @@ -4312,7 +4902,6 @@ ApiStyle.prototype.GetType = function(){ return new StyleType(); }; /** * Returns the text properties of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {ApiTextPr} */ ApiStyle.prototype.GetTextPr = function(){ return new ApiTextPr(); }; @@ -4320,7 +4909,6 @@ ApiStyle.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** * Returns the paragraph properties of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {ApiParaPr} */ ApiStyle.prototype.GetParaPr = function(){ return new ApiParaPr(); }; @@ -4328,7 +4916,6 @@ ApiStyle.prototype.GetParaPr = function(){ return new ApiParaPr(); }; /** * Returns the table properties of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {ApiTablePr} If the type of this style is not a "table" then it will return * null. */ @@ -4337,7 +4924,6 @@ ApiStyle.prototype.GetTablePr = function(){ return new ApiTablePr(); }; /** * Returns the table row properties of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {ApiTableRowPr} If the type of this style is not a "table" then it will return * null. */ @@ -4346,7 +4932,6 @@ ApiStyle.prototype.GetTableRowPr = function(){ return new ApiTableRowPr(); }; /** * Returns the table cell properties of the current style. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @returns {ApiTableCellPr} */ ApiStyle.prototype.GetTableCellPr = function(){ return new ApiTableCellPr(); }; @@ -4354,16 +4939,15 @@ ApiStyle.prototype.GetTableCellPr = function(){ return new ApiTableCellPr(); }; /** * Specifies the reference to the parent style which this style inherits from in the style hierarchy. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @param {ApiStyle} oStyle - The parent style which the style inherits properties from. + * @returns {boolean} */ -ApiStyle.prototype.SetBasedOn = function(oStyle){}; +ApiStyle.prototype.SetBasedOn = function(oStyle){ return true; }; /** * Returns a set of formatting properties which will be conditionally applied to the parts of a table that match the * requirement specified in the sType parameter. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @param {TableStyleOverrideType} [sType="wholeTable"] - The table part which the formatting properties must be applied to. * @returns {ApiTableStylePr} */ @@ -4372,7 +4956,6 @@ ApiStyle.prototype.GetConditionalTableStyle = function(sType){ return new ApiTab /** * Converts the ApiStyle object into the JSON object. * @memberof ApiStyle - * @typeofeditors ["CDE"] * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. * @returns {JSON} */ @@ -4381,7 +4964,6 @@ ApiStyle.prototype.ToJSON = function(bWriteNumberings){ return new JSON(); }; /** * Returns a type of the ApiTextPr class. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"textPr"} */ ApiTextPr.prototype.GetClassType = function(){ return ""; }; @@ -4391,7 +4973,6 @@ ApiTextPr.prototype.GetClassType = function(){ return ""; }; * This method is not used by itself, as it only forms the basis for the {@link ApiRun#SetStyle} method which sets * the selected or created style to the text. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @param {ApiStyle} oStyle - The style which must be applied to the text character. * @returns {ApiTextPr} - this text properties. */ @@ -4400,7 +4981,6 @@ ApiTextPr.prototype.SetStyle = function(oStyle){ return new ApiTextPr(); }; /** * Gets the style of the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @returns {ApiStyle} - The used style. * @since 8.1.0 */ @@ -4409,7 +4989,6 @@ ApiTextPr.prototype.GetStyle = function(){ return new ApiStyle(); }; /** * Sets the bold property to the text character. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isBold - Specifies that the contents of the run are displayed bold. * @returns {ApiTextPr} - this text properties. */ @@ -4418,7 +4997,6 @@ ApiTextPr.prototype.SetBold = function(isBold){ return new ApiTextPr(); }; /** * Gets the bold property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -4427,7 +5005,6 @@ ApiTextPr.prototype.GetBold = function(){ return true; }; /** * Sets the italic property to the text character. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isItalic - Specifies that the contents of the current run are displayed italicized. * @returns {ApiTextPr} - this text properties. */ @@ -4436,7 +5013,6 @@ ApiTextPr.prototype.SetItalic = function(isItalic){ return new ApiTextPr(); }; /** * Gets the italic property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -4445,7 +5021,6 @@ ApiTextPr.prototype.GetItalic = function(){ return true; }; /** * Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isStrikeout - Specifies that the contents of the current run are displayed struck through. * @returns {ApiTextPr} - this text properties. */ @@ -4454,7 +5029,6 @@ ApiTextPr.prototype.SetStrikeout = function(isStrikeout){ return new ApiTextPr() /** * Gets the strikeout property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -4464,7 +5038,6 @@ ApiTextPr.prototype.GetStrikeout = function(){ return true; }; * Specifies that the contents of the run are displayed along with a line appearing directly below the character * (less than all the spacing above and below the characters on the line). * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isUnderline - Specifies that the contents of the current run are displayed underlined. * @returns {ApiTextPr} - this text properties. */ @@ -4473,7 +5046,6 @@ ApiTextPr.prototype.SetUnderline = function(isUnderline){ return new ApiTextPr() /** * Gets the underline property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -4482,25 +5054,25 @@ ApiTextPr.prototype.GetUnderline = function(){ return true; }; /** * Sets all 4 font slots with the specified font family. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {string} sFontFamily - The font family or families used for the current text run. * @returns {ApiTextPr} - this text properties. */ ApiTextPr.prototype.SetFontFamily = function(sFontFamily){ return new ApiTextPr(); }; /** - * Gets the font family from the current text properties. + * Returns the font family from the current text properties. + * The method automatically calculates the font from the theme if the font was set via the theme. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] + * param {undefined | "ascii" | "eastAsia" | "hAnsi" | "cs"} [fontSlot="ascii"] - The font slot. + * If this parameter is not specified, the "ascii" value is used. * @returns {string} * @since 8.1.0 */ -ApiTextPr.prototype.GetFontFamily = function(){ return ""; }; +ApiTextPr.prototype.GetFontFamily = function(fontSlot){ return ""; }; /** * Sets the font size to the characters of the current text run. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {hps} nSize - The text size value measured in half-points (1/144 of an inch). * @returns {ApiTextPr} - this text properties. */ @@ -4509,7 +5081,6 @@ ApiTextPr.prototype.SetFontSize = function(nSize){ return new ApiTextPr(); }; /** * Gets the font size from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {hps} * @since 8.1.0 */ @@ -4518,7 +5089,6 @@ ApiTextPr.prototype.GetFontSize = function(){ return new hps(); }; /** * Sets the text color to the current text run in the RGB format. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. @@ -4530,7 +5100,6 @@ ApiTextPr.prototype.SetColor = function(r, g, b, isAuto){ return new ApiTextPr() /** * Gets the RGB color from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @returns {ApiRGBColor} * @since 8.1.0 */ @@ -4538,11 +5107,10 @@ ApiTextPr.prototype.GetColor = function(){ return new ApiRGBColor(); }; /** * Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text: - * * "baseline" - the characters in the current text run will be aligned by the default text baseline. - * * "subscript" - the characters in the current text run will be aligned below the default text baseline. - * * "superscript" - the characters in the current text run will be aligned above the default text baseline. + * "baseline" - the characters in the current text run will be aligned by the default text baseline. + * "subscript" - the characters in the current text run will be aligned below the default text baseline. + * "superscript" - the characters in the current text run will be aligned above the default text baseline. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("baseline" | "subscript" | "superscript")} sType - The vertical alignment type applied to the text contents. * @returns {ApiTextPr} - this text properties. */ @@ -4551,7 +5119,6 @@ ApiTextPr.prototype.SetVertAlign = function(sType){ return new ApiTextPr(); }; /** * Gets the vertical alignment type from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @returns {string} * @since 8.1.0 */ @@ -4560,7 +5127,6 @@ ApiTextPr.prototype.GetVertAlign = function(){ return ""; }; /** * Specifies a highlighting color which is added to the text properties and applied as a background to the contents of the current run/range/paragraph. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CPE"] * @param {highlightColor} sColor - Available highlight color. * @returns {ApiTextPr} */ @@ -4569,7 +5135,6 @@ ApiTextPr.prototype.SetHighlight = function(sColor){ return new ApiTextPr(); }; /** * Gets the highlight property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CPE"] * @returns {string} * @since 8.1.0 */ @@ -4578,7 +5143,6 @@ ApiTextPr.prototype.GetHighlight = function(){ return ""; }; /** * Sets the text spacing measured in twentieths of a point. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nSpacing - The value of the text spacing measured in twentieths of a point (1/1440 of an inch). * @returns {ApiTextPr} - this text properties. */ @@ -4587,7 +5151,6 @@ ApiTextPr.prototype.SetSpacing = function(nSpacing){ return new ApiTextPr(); }; /** * Gets the text spacing from the current text properties measured in twentieths of a point. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} * @since 8.1.0 */ @@ -4596,7 +5159,6 @@ ApiTextPr.prototype.GetSpacing = function(){ return new twips(); }; /** * Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isDoubleStrikeout - Specifies that the contents of the current run are displayed double struck through. * @returns {ApiTextPr} - this text properties. */ @@ -4605,7 +5167,6 @@ ApiTextPr.prototype.SetDoubleStrikeout = function(isDoubleStrikeout){ return new /** * Gets the double strikeout property from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -4614,7 +5175,6 @@ ApiTextPr.prototype.GetDoubleStrikeout = function(){ return true; }; /** * Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isCaps - Specifies that the contents of the current run are displayed capitalized. * @returns {ApiTextPr} - this text properties. */ @@ -4623,7 +5183,6 @@ ApiTextPr.prototype.SetCaps = function(isCaps){ return new ApiTextPr(); }; /** * Specifies whether the text with the current text properties are capitalized. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -4633,7 +5192,6 @@ ApiTextPr.prototype.GetCaps = function(){ return true; }; * Specifies that all the small letter characters in the text run are formatted for display only as their capital * letter character equivalents which are two points smaller than the actual font size specified for this text. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {boolean} isSmallCaps - Specifies if the contents of the current run are displayed capitalized two points smaller or not. * @returns {ApiTextPr} - this text properties. */ @@ -4642,7 +5200,6 @@ ApiTextPr.prototype.SetSmallCaps = function(isSmallCaps){ return new ApiTextPr() /** * Specifies whether the text with the current text properties are displayed capitalized two points smaller than the actual font size. * @memberof ApiTextPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {boolean} * @since 8.1.0 */ @@ -4652,7 +5209,6 @@ ApiTextPr.prototype.GetSmallCaps = function(){ return true; }; * Specifies an amount by which text is raised or lowered for this run in relation to the default * baseline of the surrounding non-positioned text. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @param {hps} nPosition - Specifies a positive (raised text) or negative (lowered text) * measurement in half-points (1/144 of an inch). * @returns {ApiTextPr} - this text properties. @@ -4662,7 +5218,6 @@ ApiTextPr.prototype.SetPosition = function(nPosition){ return new ApiTextPr(); } /** * Gets the text position from the current text properties measured in half-points (1/144 of an inch). * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @returns {hps} * @since 8.1.0 */ @@ -4672,7 +5227,6 @@ ApiTextPr.prototype.GetPosition = function(){ return new hps(); }; * Specifies the languages which will be used to check spelling and grammar (if requested) when processing * the contents of the text run. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @param {string} sLangId - The possible value for this parameter is a language identifier as defined by * RFC 4646/BCP 47. Example: "en-CA". * @returns {ApiTextPr} - this text properties. @@ -4682,7 +5236,6 @@ ApiTextPr.prototype.SetLanguage = function(sLangId){ return new ApiTextPr(); }; /** * Gets the language from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @returns {string} * @since 8.1.0 */ @@ -4691,7 +5244,6 @@ ApiTextPr.prototype.GetLanguage = function(){ return ""; }; /** * Specifies the shading applied to the contents of the current text run. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @param {ShdType} sType - The shading type applied to the contents of the current text run. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. @@ -4703,16 +5255,46 @@ ApiTextPr.prototype.SetShd = function(sType, r, g, b){ return new ApiTextPr(); } /** * Gets the text shading from the current text properties. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @returns {ApiRGBColor} * @since 8.1.0 */ ApiTextPr.prototype.GetShd = function(){ return new ApiRGBColor(); }; +/** + * Sets the text fill to the current text run. + * @memberof ApiTextPr + * @param {ApiFill} oApiFill - The color or pattern used to fill the text color. + * @returns {ApiTextPr} - this text properties. + */ +ApiTextPr.prototype.SetTextFill = function(oApiFill){ return new ApiTextPr(); }; + +/** + * Gets the text fill from the current text properties. + * @memberof ApiTextPr + * @returns {ApiFill} + * @since 8.1.0 + */ +ApiTextPr.prototype.GetTextFill = function(){ return new ApiFill(); }; + +/** + * Sets the text outline to the current text run. + * @memberof ApiTextPr + * @param {ApiStroke} oStroke - The stroke used to create the text outline. + * @returns {ApiTextPr} - this text properties. + */ +ApiTextPr.prototype.SetOutLine = function(oStroke){ return new ApiTextPr(); }; + +/** + * Gets the text outline from the current text properties. + * @memberof ApiTextPr + * @returns {ApiStroke} + * @since 8.1.0 + */ +ApiTextPr.prototype.GetOutLine = function(){ return new ApiStroke(); }; + /** * Converts the ApiTextPr object into the JSON object. * @memberof ApiTextPr - * @typeofeditors ["CDE"] * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} */ @@ -4721,7 +5303,6 @@ ApiTextPr.prototype.ToJSON = function(bWriteStyles){ return new JSON(); }; /** * Returns a type of the ApiParaPr class. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"paraPr"} */ ApiParaPr.prototype.GetClassType = function(){ return ""; }; @@ -4730,15 +5311,14 @@ ApiParaPr.prototype.GetClassType = function(){ return ""; }; * The paragraph style base method. * This method is not used by itself, as it only forms the basis for the {@link ApiParagraph#SetStyle} method which sets the selected or created style for the paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {ApiStyle} oStyle - The style of the paragraph to be set. + * @returns {boolean} */ -ApiParaPr.prototype.SetStyle = function(oStyle){}; +ApiParaPr.prototype.SetStyle = function(oStyle){ return true; }; /** * Returns the paragraph style method. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @returns {ApiStyle} - The style of the paragraph. */ ApiParaPr.prototype.GetStyle = function(){ return new ApiStyle(); }; @@ -4748,23 +5328,22 @@ ApiParaPr.prototype.GetStyle = function(){ return new ApiStyle(); }; * {@link ApiParaPr#SetSpacingBefore} or {@link ApiParaPr#SetSpacingAfter} spacing element, should not be applied when the preceding and * following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {boolean} isContextualSpacing - The true value will enable the paragraph contextual spacing. + * @returns {boolean} */ -ApiParaPr.prototype.SetContextualSpacing = function(isContextualSpacing){}; +ApiParaPr.prototype.SetContextualSpacing = function(isContextualSpacing){ return true; }; /** * Sets the paragraph left side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph left side indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndLeft = function(nValue){}; +ApiParaPr.prototype.SetIndLeft = function(nValue){ return true; }; /** * Returns the paragraph left side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph left side indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndLeft = function(){ return new twips(); }; @@ -4772,15 +5351,14 @@ ApiParaPr.prototype.GetIndLeft = function(){ return new twips(); }; /** * Sets the paragraph right side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph right side indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndRight = function(nValue){}; +ApiParaPr.prototype.SetIndRight = function(nValue){ return true; }; /** * Returns the paragraph right side indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph right side indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndRight = function(){ return new twips(); }; @@ -4788,15 +5366,14 @@ ApiParaPr.prototype.GetIndRight = function(){ return new twips(); }; /** * Sets the paragraph first line indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nValue - The paragraph first line indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiParaPr.prototype.SetIndFirstLine = function(nValue){}; +ApiParaPr.prototype.SetIndFirstLine = function(nValue){ return true; }; /** * Returns the paragraph first line indentation. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | undefined} - The paragraph first line indentation value measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetIndFirstLine = function(){ return new twips(); }; @@ -4804,16 +5381,15 @@ ApiParaPr.prototype.GetIndFirstLine = function(){ return new twips(); }; /** * Sets the paragraph contents justification. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {("left" | "right" | "both" | "center")} sJc - The justification type that * will be applied to the paragraph contents. + * @returns {boolean} */ -ApiParaPr.prototype.SetJc = function(sJc){}; +ApiParaPr.prototype.SetJc = function(sJc){ return true; }; /** * Returns the paragraph contents justification. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {("left" | "right" | "both" | "center" | undefined)} */ ApiParaPr.prototype.GetJc = function(){ return ""; }; @@ -4821,30 +5397,30 @@ ApiParaPr.prototype.GetJc = function(){ return ""; }; /** * Specifies that when rendering the document using a page view, all lines of the current paragraph are maintained on a single page whenever possible. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {boolean} isKeepLines - The true value enables the option to keep lines of the paragraph on a single page. + * @returns {boolean} */ -ApiParaPr.prototype.SetKeepLines = function(isKeepLines){}; +ApiParaPr.prototype.SetKeepLines = function(isKeepLines){ return true; }; /** * Specifies that when rendering the document using a paginated view, the contents of the current paragraph are at least * partly rendered on the same page as the following paragraph whenever possible. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {boolean} isKeepNext - The true value enables the option to keep lines of the paragraph on the same * page as the following paragraph. + * @returns {boolean} */ -ApiParaPr.prototype.SetKeepNext = function(isKeepNext){}; +ApiParaPr.prototype.SetKeepNext = function(isKeepNext){ return true; }; /** * Specifies that when rendering the document using a paginated view, the contents of the current paragraph are rendered at * the beginning of a new page in the document. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {boolean} isPageBreakBefore - The true value enables the option to render the contents of the paragraph * at the beginning of a new page in the document. + * @returns {boolean} */ -ApiParaPr.prototype.SetPageBreakBefore = function(isPageBreakBefore){}; +ApiParaPr.prototype.SetPageBreakBefore = function(isPageBreakBefore){ return true; }; /** * Sets the paragraph line spacing. If the value of the sLineRule parameter is either @@ -4852,16 +5428,15 @@ ApiParaPr.prototype.SetPageBreakBefore = function(isPageBreakBefore){}; * the value of the sLineRule parameter is "auto", then the value of the * nLine parameter will be interpreted as 240ths of a line. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {(twips | line240)} nLine - The line spacing value measured either in twentieths of a point (1/1440 of an inch) or in 240ths of a line. * @param {("auto" | "atLeast" | "exact")} sLineRule - The rule that determines the measuring units of the line spacing. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingLine = function(nLine, sLineRule){}; +ApiParaPr.prototype.SetSpacingLine = function(nLine, sLineRule){ return true; }; /** * Returns the paragraph line spacing value. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips | line240 | undefined} - to know is twips or line240 use ApiParaPr.prototype.GetSpacingLineRule(). */ ApiParaPr.prototype.GetSpacingLineValue = function(){ return new twips(); }; @@ -4869,7 +5444,6 @@ ApiParaPr.prototype.GetSpacingLineValue = function(){ return new twips(); }; /** * Returns the paragraph line spacing rule. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"auto" | "atLeast" | "exact" | undefined} */ ApiParaPr.prototype.GetSpacingLineRule = function(){ return ""; }; @@ -4879,16 +5453,15 @@ ApiParaPr.prototype.GetSpacingLineRule = function(){ return ""; }; * any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then * it will be interpreted as false. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nBefore - The value of the spacing before the current paragraph measured in twentieths of a point (1/1440 of an inch). * @param {boolean} [isBeforeAuto=false] - The true value disables the spacing before the current paragraph. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingBefore = function(nBefore, isBeforeAuto){}; +ApiParaPr.prototype.SetSpacingBefore = function(nBefore, isBeforeAuto){ return true; }; /** * Returns the spacing before value of the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} - The value of the spacing before the current paragraph measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetSpacingBefore = function(){ return new twips(); }; @@ -4898,16 +5471,15 @@ ApiParaPr.prototype.GetSpacingBefore = function(){ return new twips(); }; * any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it * will be interpreted as false. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips} nAfter - The value of the spacing after the current paragraph measured in twentieths of a point (1/1440 of an inch). * @param {boolean} [isAfterAuto=false] - The true value disables the spacing after the current paragraph. + * @returns {boolean} */ -ApiParaPr.prototype.SetSpacingAfter = function(nAfter, isAfterAuto){}; +ApiParaPr.prototype.SetSpacingAfter = function(nAfter, isAfterAuto){ return true; }; /** * Returns the spacing after value of the current paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {twips} - The value of the spacing after the current paragraph measured in twentieths of a point (1/1440 of an inch). */ ApiParaPr.prototype.GetSpacingAfter = function(){ return new twips(); }; @@ -4915,19 +5487,18 @@ ApiParaPr.prototype.GetSpacingAfter = function(){ return new twips(); }; /** * Specifies the shading applied to the contents of the paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {ShdType} sType - The shading type which will be applied to the contents of the current paragraph. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} [isAuto=false] - The true value disables paragraph contents shading. + * @returns {boolean} */ -ApiParaPr.prototype.SetShd = function(sType, r, g, b, isAuto){}; +ApiParaPr.prototype.SetShd = function(sType, r, g, b, isAuto){ return true; }; /** * Returns the shading applied to the contents of the paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @returns {ApiRGBColor} */ ApiParaPr.prototype.GetShd = function(){ return new ApiRGBColor(); }; @@ -4937,104 +5508,121 @@ ApiParaPr.prototype.GetShd = function(){ return new ApiRGBColor(); }; * The paragraphs of the same style going one by one are considered as a single block, so the border is added * to the whole block rather than to every paragraph in this block. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The border style. * @param {pt_8} nSize - The width of the current bottom border measured in eighths of a point. * @param {pt} nSpace - The spacing offset below the paragraph measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiParaPr.prototype.SetBottomBorder = function(sType, nSize, nSpace, r, g, b){}; +ApiParaPr.prototype.SetBottomBorder = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies the border which will be displayed at the left side of the page around the specified paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The border style. * @param {pt_8} nSize - The width of the current left border measured in eighths of a point. * @param {pt} nSpace - The spacing offset to the left of the paragraph measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiParaPr.prototype.SetLeftBorder = function(sType, nSize, nSpace, r, g, b){}; +ApiParaPr.prototype.SetLeftBorder = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies the border which will be displayed at the right side of the page around the specified paragraph. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The border style. * @param {pt_8} nSize - The width of the current right border measured in eighths of a point. * @param {pt} nSpace - The spacing offset to the right of the paragraph measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiParaPr.prototype.SetRightBorder = function(sType, nSize, nSpace, r, g, b){}; +ApiParaPr.prototype.SetRightBorder = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings. * The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The border style. * @param {pt_8} nSize - The width of the current top border measured in eighths of a point. * @param {pt} nSpace - The spacing offset above the paragraph measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiParaPr.prototype.SetTopBorder = function(sType, nSize, nSpace, r, g, b){}; +ApiParaPr.prototype.SetTopBorder = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The border style. * @param {pt_8} nSize - The width of the current border measured in eighths of a point. * @param {pt} nSpace - The spacing offset between the paragraphs measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiParaPr.prototype.SetBetweenBorder = function(sType, nSize, nSpace, r, g, b){}; +ApiParaPr.prototype.SetBetweenBorder = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies whether a single line of the current paragraph will be displayed on a separate page from the remaining content at display time by moving the line onto the following page. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {boolean} isWidowControl - The true value means that a single line of the current paragraph will be displayed on a separate page from the remaining content at display time by moving the line onto the following page. + * @returns {boolean} */ -ApiParaPr.prototype.SetWidowControl = function(isWidowControl){}; +ApiParaPr.prototype.SetWidowControl = function(isWidowControl){ return true; }; /** * Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph. * Warning: The lengths of aPos array and aVal array MUST BE equal to each other. * @memberof ApiParaPr - * @typeofeditors ["CDE", "CSE", "CPE"] * @param {twips[]} aPos - An array of the positions of custom tab stops with respect to the current page margins * measured in twentieths of a point (1/1440 of an inch). * @param {TabJc[]} aVal - An array of the styles of custom tab stops, which determines the behavior of the tab * stop and the alignment which will be applied to text entered at the current custom tab stop. + * @returns {boolean} */ -ApiParaPr.prototype.SetTabs = function(aPos, aVal){}; +ApiParaPr.prototype.SetTabs = function(aPos, aVal){ return true; }; /** * Specifies that the current paragraph references a numbering definition instance in the current document. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {ApiNumbering} oNumPr - Specifies a numbering definition. * @param {number} [nLvl=0] - Specifies a numbering level reference. If the current instance of the ApiParaPr class is direct * formatting of a paragraph, then this parameter MUST BE specified. Otherwise, if the current instance of the ApiParaPr class * is the part of ApiStyle properties, this parameter will be ignored. + * @returns {boolean} */ -ApiParaPr.prototype.SetNumPr = function(oNumPr, nLvl){}; +ApiParaPr.prototype.SetNumPr = function(oNumPr, nLvl){ return true; }; + +/** + * Sets the outline level for the specified properties. + * @memberof ApiParaPr + * @param {Number} [nLvl=undefined] - The outline level. Possible values: 0-8. The 0 value means the basic outline level. + * To set no outline level, use this method without a parameter. + * @returns {boolean} + * @since 8.2.0 + */ +ApiParaPr.prototype.SetOutlineLvl = function(nLvl){ return true; }; + +/** + * Returns the outline level of the specified properties. + * @memberof ApiParaPr + * @returns {Number} + * @since 8.2.0 + */ +ApiParaPr.prototype.GetOutlineLvl = function(){ return 0; }; /** * Converts the ApiParaPr object into the JSON object. * @memberof ApiParaPr - * @typeofeditors ["CDE"] * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} */ @@ -5043,7 +5631,6 @@ ApiParaPr.prototype.ToJSON = function(bWriteStyles){ return new JSON(); }; /** * Returns a type of the ApiNumbering class. * @memberof ApiNumbering - * @typeofeditors ["CDE"] * @returns {"numbering"} */ ApiNumbering.prototype.GetClassType = function(){ return ""; }; @@ -5051,7 +5638,6 @@ ApiNumbering.prototype.GetClassType = function(){ return ""; }; /** * Returns the specified level of the current numbering. * @memberof ApiNumbering - * @typeofeditors ["CDE"] * @param {number} nLevel - The numbering level index. This value MUST BE from 0 to 8. * @returns {ApiNumberingLevel} */ @@ -5060,7 +5646,6 @@ ApiNumbering.prototype.GetLevel = function(nLevel){ return new ApiNumberingLevel /** * Converts the ApiNumbering object into the JSON object. * @memberof ApiNumbering - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiNumbering.prototype.ToJSON = function(){ return new JSON(); }; @@ -5068,7 +5653,6 @@ ApiNumbering.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiNumberingLevel class. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @returns {"numberingLevel"} */ ApiNumberingLevel.prototype.GetClassType = function(){ return ""; }; @@ -5076,7 +5660,6 @@ ApiNumberingLevel.prototype.GetClassType = function(){ return ""; }; /** * Returns the numbering definition. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @returns {ApiNumbering} */ ApiNumberingLevel.prototype.GetNumbering = function(){ return new ApiNumbering(); }; @@ -5084,7 +5667,6 @@ ApiNumberingLevel.prototype.GetNumbering = function(){ return new ApiNumbering() /** * Returns the level index. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @returns {number} */ ApiNumberingLevel.prototype.GetLevelIndex = function(){ return 0; }; @@ -5093,7 +5675,6 @@ ApiNumberingLevel.prototype.GetLevelIndex = function(){ return 0; }; * Specifies the text properties which will be applied to the text in the current numbering level itself, not to the text in the subsequent paragraph. * To change the text style of the paragraph, a style must be applied to it using the {@link ApiRun#SetStyle} method. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @returns {ApiTextPr} */ ApiNumberingLevel.prototype.GetTextPr = function(){ return new ApiTextPr(); }; @@ -5101,7 +5682,6 @@ ApiNumberingLevel.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** * Returns the paragraph properties which are applied to any numbered paragraph that references the given numbering definition and numbering level. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @returns {ApiParaPr} */ ApiNumberingLevel.prototype.GetParaPr = function(){ return new ApiParaPr(); }; @@ -5109,51 +5689,59 @@ ApiNumberingLevel.prototype.GetParaPr = function(){ return new ApiParaPr(); }; /** * Sets one of the existing predefined numbering templates. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @param {("none" | "bullet" | "1)" | "1." | "I." | "A." | "a)" | "a." | "i." )} sType - The predefined numbering template. * @param {string} [sSymbol=""] - The symbol used for the list numbering. This parameter has the meaning only if the predefined numbering template is "bullet". + * @returns {boolean} */ -ApiNumberingLevel.prototype.SetTemplateType = function(sType, sSymbol){}; +ApiNumberingLevel.prototype.SetTemplateType = function(sType, sSymbol){ return true; }; /** * Sets your own customized numbering type. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @param {("none" | "bullet" | "decimal" | "lowerRoman" | "upperRoman" | "lowerLetter" | "upperLetter" | * "decimalZero")} sType - The custom numbering type used for the current numbering definition. * @param {string} sTextFormatString - Any text in this parameter will be taken as literal text to be repeated in each instance of this numbering level, except for any use of the percent symbol (%) followed by a number, which will be used to indicate the one-based index of the number to be used at this level. Any number of a level higher than this level will be ignored. * @param {("left" | "right" | "center")} sAlign - Type of justification applied to the text run in the current numbering level. + * @returns {boolean} */ -ApiNumberingLevel.prototype.SetCustomType = function(sType, sTextFormatString, sAlign){}; +ApiNumberingLevel.prototype.SetCustomType = function(sType, sTextFormatString, sAlign){ return true; }; /** * Specifies a one-based index which determines when a numbering level should restart to its starting value. A numbering level restarts when an instance of the specified numbering level which is higher (earlier than this level) is used in the given document contents. By default this value is true. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @param {boolean} isRestart - The true value means that a numbering level will be restarted to its starting value. + * @returns {boolean} */ -ApiNumberingLevel.prototype.SetRestart = function(isRestart){}; +ApiNumberingLevel.prototype.SetRestart = function(isRestart){ return true; }; /** * Specifies the starting value for the numbering used by the parent numbering level within a given numbering level definition. By default this value is 1. * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @param {number} nStart - The starting value for the numbering used by the parent numbering level. + * @returns {boolean} */ -ApiNumberingLevel.prototype.SetStart = function(nStart){}; +ApiNumberingLevel.prototype.SetStart = function(nStart){ return true; }; /** * Specifies the content which will be added between the given numbering level text and the text of every numbered paragraph which references that numbering level. By default this value is "tab". * @memberof ApiNumberingLevel - * @typeofeditors ["CDE"] * @param {("space" | "tab" | "none")} sType - The content added between the numbering level text and the text in the numbered paragraph. + * @returns {boolean} */ -ApiNumberingLevel.prototype.SetSuff = function(sType){}; +ApiNumberingLevel.prototype.SetSuff = function(sType){ return true; }; + +/** + * Links the specified paragraph style with the current numbering level. + * @memberof ApiNumberingLevel + * @param {ApiStyle} oStyle - The paragraph style. + * @returns {boolean} + * @since 8.3.0 + */ +ApiNumberingLevel.prototype.LinkWithStyle = function(oStyle){ return true; }; /** * Returns a type of the ApiTablePr class. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @returns {"tablePr"} */ ApiTablePr.prototype.GetClassType = function(){ return ""; }; @@ -5161,195 +5749,208 @@ ApiTablePr.prototype.GetClassType = function(){ return ""; }; /** * Specifies a number of columns which will comprise each table column band for this table style. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {number} nCount - The number of columns measured in positive integers. + * @returns {boolean} */ -ApiTablePr.prototype.SetStyleColBandSize = function(nCount){}; +ApiTablePr.prototype.SetStyleColBandSize = function(nCount){ return true; }; /** * Specifies a number of rows which will comprise each table row band for this table style. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {number} nCount - The number of rows measured in positive integers. + * @returns {boolean} */ -ApiTablePr.prototype.SetStyleRowBandSize = function(nCount){}; +ApiTablePr.prototype.SetStyleRowBandSize = function(nCount){ return true; }; /** * Specifies the alignment of the current table with respect to the text margins in the current section. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {("left" | "right" | "center")} sJcType - The alignment type used for the current table placement. + * @returns {boolean} */ -ApiTablePr.prototype.SetJc = function(sJcType){}; +ApiTablePr.prototype.SetJc = function(sJcType){ return true; }; /** * Specifies the shading which is applied to the extents of the current table. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {ShdType} sType - The shading type applied to the extents of the current table. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} [isAuto=false] - The true value disables the SetShd method use. + * @returns {boolean} */ -ApiTablePr.prototype.SetShd = function(sType, r, g, b, isAuto){}; +ApiTablePr.prototype.SetShd = function(sType, r, g, b, isAuto){ return true; }; /** * Sets the border which will be displayed at the top of the current table. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The top border style. * @param {pt_8} nSize - The width of the current top border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the top part of the table measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTablePr.prototype.SetTableBorderTop = function(sType, nSize, nSpace, r, g, b){}; +ApiTablePr.prototype.SetTableBorderTop = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Sets the border which will be displayed at the bottom of the current table. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The bottom border style. * @param {pt_8} nSize - The width of the current bottom border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the bottom part of the table measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTablePr.prototype.SetTableBorderBottom = function(sType, nSize, nSpace, r, g, b){}; +ApiTablePr.prototype.SetTableBorderBottom = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Sets the border which will be displayed on the left of the current table. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The left border style. * @param {pt_8} nSize - The width of the current left border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the left part of the table measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTablePr.prototype.SetTableBorderLeft = function(sType, nSize, nSpace, r, g, b){}; +ApiTablePr.prototype.SetTableBorderLeft = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Sets the border which will be displayed on the right of the current table. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The right border style. * @param {pt_8} nSize - The width of the current right border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the right part of the table measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTablePr.prototype.SetTableBorderRight = function(sType, nSize, nSpace, r, g, b){}; +ApiTablePr.prototype.SetTableBorderRight = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies the border which will be displayed on all horizontal table cell borders which are not on the outmost edge * of the parent table (all horizontal borders which are not the topmost or bottommost borders). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The horizontal table cell border style. * @param {pt_8} nSize - The width of the current border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the horizontal table cells of the table measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTablePr.prototype.SetTableBorderInsideH = function(sType, nSize, nSpace, r, g, b){}; +ApiTablePr.prototype.SetTableBorderInsideH = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies the border which will be displayed on all vertical table cell borders which are not on the outmost edge * of the parent table (all vertical borders which are not the leftmost or rightmost borders). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The vertical table cell border style. * @param {pt_8} nSize - The width of the current border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the vertical table cells of the table measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTablePr.prototype.SetTableBorderInsideV = function(sType, nSize, nSpace, r, g, b){}; +ApiTablePr.prototype.SetTableBorderInsideV = function(sType, nSize, nSpace, r, g, b){ return true; }; + +/** + * Specifies a border which will be displayed on all table cell borders. + * @memberof ApiTablePr + * @param {BorderType} sType - The border style. + * @param {pt_8} nSize - The width of the current border measured in eighths of a point. + * @param {pt} nSpace - The spacing offset in the table cells measured in points used to place this border. + * @param {byte} r - Red color component value. + * @param {byte} g - Green color component value. + * @param {byte} b - Blue color component value. + * @returns {boolean} + * @since 9.0.0 + */ +ApiTablePr.prototype.SetTableBorderAll = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Specifies an amount of space which will be left between the bottom extent of the cell contents and the border * of all table cells within the parent table (or table row). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {twips} nValue - The value for the amount of space below the bottom extent of the cell measured in * twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiTablePr.prototype.SetTableCellMarginBottom = function(nValue){}; +ApiTablePr.prototype.SetTableCellMarginBottom = function(nValue){ return true; }; /** * Specifies an amount of space which will be left between the left extent of the cell contents and the left * border of all table cells within the parent table (or table row). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {twips} nValue - The value for the amount of space to the left extent of the cell measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiTablePr.prototype.SetTableCellMarginLeft = function(nValue){}; +ApiTablePr.prototype.SetTableCellMarginLeft = function(nValue){ return true; }; /** * Specifies an amount of space which will be left between the right extent of the cell contents and the right * border of all table cells within the parent table (or table row). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {twips} nValue - The value for the amount of space to the right extent of the cell measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiTablePr.prototype.SetTableCellMarginRight = function(nValue){}; +ApiTablePr.prototype.SetTableCellMarginRight = function(nValue){ return true; }; /** * Specifies an amount of space which will be left between the top extent of the cell contents and the top border * of all table cells within the parent table (or table row). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {twips} nValue - The value for the amount of space above the top extent of the cell measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiTablePr.prototype.SetTableCellMarginTop = function(nValue){}; +ApiTablePr.prototype.SetTableCellMarginTop = function(nValue){ return true; }; /** * Specifies the default table cell spacing (the spacing between adjacent cells and the edges of the table). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {?twips} nValue - Spacing value measured in twentieths of a point (1/1440 of an inch). "Null" means that no spacing will be applied. + * @returns {boolean} */ -ApiTablePr.prototype.SetCellSpacing = function(nValue){}; +ApiTablePr.prototype.SetCellSpacing = function(nValue){ return true; }; /** * Specifies the indentation which will be added before the leading edge of the current table in the document * (the left edge in the left-to-right table, and the right edge in the right-to-left table). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {twips} nValue - The indentation value measured in twentieths of a point (1/1440 of an inch). + * @returns {boolean} */ -ApiTablePr.prototype.SetTableInd = function(nValue){}; +ApiTablePr.prototype.SetTableInd = function(nValue){ return true; }; /** * Sets the preferred width to the current table. * Tables are created with the {@link ApiTable#SetWidth} method properties set by default, which always override the {@link ApiTablePr#SetWidth} method properties. That is why there is no use to try and apply {@link ApiTablePr#SetWidth}. We recommend you to use the {@link ApiTablePr#SetWidth} method instead. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {TableWidth} sType - Type of the width value from one of the available width values types. * @param {number} [nValue] - The table width value measured in positive integers. + * @returns {boolean} */ -ApiTablePr.prototype.SetWidth = function(sType, nValue){}; +ApiTablePr.prototype.SetWidth = function(sType, nValue){ return true; }; /** * Specifies the algorithm which will be used to lay out the contents of the current table within the document. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {("autofit" | "fixed")} sType - The type of the table layout in the document. + * @returns {boolean} */ -ApiTablePr.prototype.SetTableLayout = function(sType){}; +ApiTablePr.prototype.SetTableLayout = function(sType){ return true; }; /** * Sets the table title (caption). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {string} sTitle - The table title to be set. * @returns {boolean} */ @@ -5358,7 +5959,6 @@ ApiTablePr.prototype.SetTableTitle = function(sTitle){ return true; }; /** * Returns the table title (caption). * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @returns {string} */ ApiTablePr.prototype.GetTableTitle = function(){ return ""; }; @@ -5366,7 +5966,6 @@ ApiTablePr.prototype.GetTableTitle = function(){ return ""; }; /** * Sets the table description. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @param {string} sDescr - The table description to be set. * @returns {boolean} */ @@ -5375,7 +5974,6 @@ ApiTablePr.prototype.SetTableDescription = function(sDescr){ return true; }; /** * Returns the table description. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @returns {string} */ ApiTablePr.prototype.GetTableDescription = function(){ return ""; }; @@ -5383,7 +5981,6 @@ ApiTablePr.prototype.GetTableDescription = function(){ return ""; }; /** * Converts the ApiTablePr object into the JSON object. * @memberof ApiTablePr - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiTablePr.prototype.ToJSON = function(){ return new JSON(); }; @@ -5391,7 +5988,6 @@ ApiTablePr.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiTableRowPr class. * @memberof ApiTableRowPr - * @typeofeditors ["CDE"] * @returns {"tableRowPr"} */ ApiTableRowPr.prototype.GetClassType = function(){ return ""; }; @@ -5399,11 +5995,11 @@ ApiTableRowPr.prototype.GetClassType = function(){ return ""; }; /** * Sets the height to the current table row within the current table. * @memberof ApiTableRowPr - * @typeofeditors ["CDE"] * @param {("auto" | "atLeast")} sHRule - The rule to apply the height value to the current table row or ignore it. Use the "atLeast" value to enable the SetHeight method use. * @param {twips} [nValue] - The height for the current table row measured in twentieths of a point (1/1440 of an inch). This value will be ignored if sHRule="auto". + * @returns {boolean} */ -ApiTableRowPr.prototype.SetHeight = function(sHRule, nValue){}; +ApiTableRowPr.prototype.SetHeight = function(sHRule, nValue){ return true; }; /** * Specifies that the current table row will be repeated at the top of each new page @@ -5411,15 +6007,14 @@ ApiTableRowPr.prototype.SetHeight = function(sHRule, nValue){}; * each of these pages. This element can be applied to any number of rows at the top of the * table structure in order to generate multi-row table headers. * @memberof ApiTableRowPr - * @typeofeditors ["CDE"] * @param {boolean} isHeader - The true value means that the current table row will be repeated at the top of each new page. + * @returns {boolean} */ -ApiTableRowPr.prototype.SetTableHeader = function(isHeader){}; +ApiTableRowPr.prototype.SetTableHeader = function(isHeader){ return true; }; /** * Converts the ApiTableRowPr object into the JSON object. * @memberof ApiTableRowPr - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiTableRowPr.prototype.ToJSON = function(){ return new JSON(); }; @@ -5427,7 +6022,6 @@ ApiTableRowPr.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiTableCellPr class. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @returns {"tableCellPr"} */ ApiTableCellPr.prototype.GetClassType = function(){ return ""; }; @@ -5435,150 +6029,149 @@ ApiTableCellPr.prototype.GetClassType = function(){ return ""; }; /** * Specifies the shading applied to the contents of the table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {ShdType} sType - The shading type which will be applied to the contents of the current table cell. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} [isAuto=false] - The true value disables the table cell contents shading. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetShd = function(sType, r, g, b, isAuto){}; +ApiTableCellPr.prototype.SetShd = function(sType, r, g, b, isAuto){ return true; }; /** * Specifies an amount of space which will be left between the bottom extent of the cell contents and the border * of a specific table cell within a table. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {?twips} nValue - The value for the amount of space below the bottom extent of the cell measured in twentieths * of a point (1/1440 of an inch). If this value is null, then default table cell bottom margin will be used, otherwise * the table cell bottom margin will be overridden with the specified value for the current cell. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellMarginBottom = function(nValue){}; +ApiTableCellPr.prototype.SetCellMarginBottom = function(nValue){ return true; }; /** * Specifies an amount of space which will be left between the left extent of the cell contents and * the border of a specific table cell within a table. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {?twips} nValue - The value for the amount of space to the left extent of the cell measured in twentieths * of a point (1/1440 of an inch). If this value is null, then default table cell left margin will be used, otherwise * the table cell left margin will be overridden with the specified value for the current cell. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellMarginLeft = function(nValue){}; +ApiTableCellPr.prototype.SetCellMarginLeft = function(nValue){ return true; }; /** * Specifies an amount of space which will be left between the right extent of the cell contents and the border of a specific table cell within a table. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {?twips} nValue - The value for the amount of space to the right extent of the cell measured in twentieths * of a point (1/1440 of an inch). If this value is null, then default table cell right margin will be used, otherwise * the table cell right margin will be overridden with the specified value for the current cell. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellMarginRight = function(nValue){}; +ApiTableCellPr.prototype.SetCellMarginRight = function(nValue){ return true; }; /** * Specifies an amount of space which will be left between the upper extent of the cell contents * and the border of a specific table cell within a table. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {?twips} nValue - The value for the amount of space above the upper extent of the cell measured in twentieths * of a point (1/1440 of an inch). If this value is null, then default table cell top margin will be used, otherwise * the table cell top margin will be overridden with the specified value for the current cell. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellMarginTop = function(nValue){}; +ApiTableCellPr.prototype.SetCellMarginTop = function(nValue){ return true; }; /** * Sets the border which will be displayed at the bottom of the current table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The cell bottom border style. * @param {pt_8} nSize - The width of the current cell bottom border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the bottom part of the table cell measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellBorderBottom = function(sType, nSize, nSpace, r, g, b){}; +ApiTableCellPr.prototype.SetCellBorderBottom = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Sets the border which will be displayed to the left of the current table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The cell left border style. * @param {pt_8} nSize - The width of the current cell left border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the left part of the table cell measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellBorderLeft = function(sType, nSize, nSpace, r, g, b){}; +ApiTableCellPr.prototype.SetCellBorderLeft = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Sets the border which will be displayed to the right of the current table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The cell right border style. * @param {pt_8} nSize - The width of the current cell right border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the right part of the table cell measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellBorderRight = function(sType, nSize, nSpace, r, g, b){}; +ApiTableCellPr.prototype.SetCellBorderRight = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Sets the border which will be displayed at the top of the current table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {BorderType} sType - The cell top border style. * @param {pt_8} nSize - The width of the current cell top border measured in eighths of a point. * @param {pt} nSpace - The spacing offset in the top part of the table cell measured in points used to place this border. * @param {byte} r - Red color component value. * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetCellBorderTop = function(sType, nSize, nSpace, r, g, b){}; +ApiTableCellPr.prototype.SetCellBorderTop = function(sType, nSize, nSpace, r, g, b){ return true; }; /** * Sets the preferred width to the current table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {TableWidth} sType - Type of the width value from one of the available width values types. * @param {number} [nValue] - The table cell width value measured in positive integers. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetWidth = function(sType, nValue){}; +ApiTableCellPr.prototype.SetWidth = function(sType, nValue){ return true; }; /** * Specifies the vertical alignment for the text contents within the current table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {("top" | "center" | "bottom")} sType - The available types of the vertical alignment for the text contents of the current table cell. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetVerticalAlign = function(sType){}; +ApiTableCellPr.prototype.SetVerticalAlign = function(sType){ return true; }; /** * Specifies the direction of the text flow for this table cell. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {("lrtb" | "tbrl" | "btlr")} sType - The available types of the text direction in the table cell: "lrtb" * - text direction left-to-right moving from top to bottom, "tbrl" - text direction top-to-bottom moving from right * to left, "btlr" - text direction bottom-to-top moving from left to right. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetTextDirection = function(sType){}; +ApiTableCellPr.prototype.SetTextDirection = function(sType){ return true; }; /** * Specifies how the current table cell is laid out when the parent table is displayed in a document. This setting * only affects the behavior of the cell when the {@link ApiTablePr#SetTableLayout} table layout for this table is set to use the "autofit" algorithm. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @param {boolean} isNoWrap - The true value means that the current table cell will not be wrapped in the parent table. + * @returns {boolean} */ -ApiTableCellPr.prototype.SetNoWrap = function(isNoWrap){}; +ApiTableCellPr.prototype.SetNoWrap = function(isNoWrap){ return true; }; /** * Converts the ApiTableCellPr object into the JSON object. * @memberof ApiTableCellPr - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiTableCellPr.prototype.ToJSON = function(){ return new JSON(); }; @@ -5586,7 +6179,6 @@ ApiTableCellPr.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiTableStylePr class. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {"tableStylePr"} */ ApiTableStylePr.prototype.GetClassType = function(){ return ""; }; @@ -5594,7 +6186,6 @@ ApiTableStylePr.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the current table conditional style. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {TableStyleOverrideType} */ ApiTableStylePr.prototype.GetType = function(){ return new TableStyleOverrideType(); }; @@ -5602,7 +6193,6 @@ ApiTableStylePr.prototype.GetType = function(){ return new TableStyleOverrideTyp /** * Returns a set of the text run properties which will be applied to all the text runs within the table which match the conditional formatting type. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {ApiTextPr} */ ApiTableStylePr.prototype.GetTextPr = function(){ return new ApiTextPr(); }; @@ -5610,7 +6200,6 @@ ApiTableStylePr.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** * Returns a set of the paragraph properties which will be applied to all the paragraphs within a table which match the conditional formatting type. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {ApiParaPr} */ ApiTableStylePr.prototype.GetParaPr = function(){ return new ApiParaPr(); }; @@ -5618,7 +6207,6 @@ ApiTableStylePr.prototype.GetParaPr = function(){ return new ApiParaPr(); }; /** * Returns a set of the table properties which will be applied to all the regions within a table which match the conditional formatting type. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {ApiTablePr} */ ApiTableStylePr.prototype.GetTablePr = function(){ return new ApiTablePr(); }; @@ -5626,7 +6214,6 @@ ApiTableStylePr.prototype.GetTablePr = function(){ return new ApiTablePr(); }; /** * Returns a set of the table row properties which will be applied to all the rows within a table which match the conditional formatting type. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {ApiTableRowPr} */ ApiTableStylePr.prototype.GetTableRowPr = function(){ return new ApiTableRowPr(); }; @@ -5634,7 +6221,6 @@ ApiTableStylePr.prototype.GetTableRowPr = function(){ return new ApiTableRowPr() /** * Returns a set of the table cell properties which will be applied to all the cells within a table which match the conditional formatting type. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {ApiTableCellPr} */ ApiTableStylePr.prototype.GetTableCellPr = function(){ return new ApiTableCellPr(); }; @@ -5642,7 +6228,6 @@ ApiTableStylePr.prototype.GetTableCellPr = function(){ return new ApiTableCellPr /** * Converts the ApiTableStylePr object into the JSON object. * @memberof ApiTableStylePr - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiTableStylePr.prototype.ToJSON = function(){ return new JSON(); }; @@ -5650,88 +6235,93 @@ ApiTableStylePr.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiDrawing class. * @memberof ApiDrawing - * @typeofeditors ["CDE", "CPE"] * @returns {"drawing"} */ ApiDrawing.prototype.GetClassType = function(){ return ""; }; +/** + * Returns the drawing inner contents where a paragraph or text runs can be inserted if it exists. + * @memberof ApiDrawing + * @returns {ApiDocumentContent} + */ +ApiDrawing.prototype.GetContent = function(){ return new ApiDocumentContent(); }; + /** * Sets the size of the object (image, shape, chart) bounding box. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {EMU} nWidth - The object width measured in English measure units. * @param {EMU} nHeight - The object height measured in English measure units. + * @returns {boolean} */ -ApiDrawing.prototype.SetSize = function(nWidth, nHeight){}; +ApiDrawing.prototype.SetSize = function(nWidth, nHeight){ return true; }; /** * Sets the wrapping type of the current object (image, shape, chart). One of the following wrapping style types can be set: - * * "inline" - the object is considered to be a part of the text, like a character, so when the text moves, the object moves as well. In this case the positioning options are inaccessible. + * "inline" - the object is considered to be a part of the text, like a character, so when the text moves, the object moves as well. In this case the positioning options are inaccessible. * If one of the following styles is selected, the object can be moved independently of the text and positioned on the page exactly: - * * "square" - the text wraps the rectangular box that bounds the object. - * * "tight" - the text wraps the actual object edges. - * * "through" - the text wraps around the object edges and fills in the open white space within the object. - * * "topAndBottom" - the text is only above and below the object. - * * "behind" - the text overlaps the object. - * * "inFront" - the object overlaps the text. + * "square" - the text wraps the rectangular box that bounds the object. + * "tight" - the text wraps the actual object edges. + * "through" - the text wraps around the object edges and fills in the open white space within the object. + * "topAndBottom" - the text is only above and below the object. + * "behind" - the text overlaps the object. + * "inFront" - the object overlaps the text. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {"inline" | "square" | "tight" | "through" | "topAndBottom" | "behind" | "inFront"} sType - The wrapping style type available for the object. + * @returns {boolean} */ -ApiDrawing.prototype.SetWrappingStyle = function(sType){}; +ApiDrawing.prototype.SetWrappingStyle = function(sType){ return true; }; /** * Specifies how the floating object will be horizontally aligned. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {RelFromH} [sRelativeFrom="page"] - The document element which will be taken as a countdown point for the object horizontal alignment. * @param {("left" | "right" | "center")} [sAlign="left"] - The alignment type which will be used for the object horizontal alignment. + * @returns {boolean} */ -ApiDrawing.prototype.SetHorAlign = function(sRelativeFrom, sAlign){}; +ApiDrawing.prototype.SetHorAlign = function(sRelativeFrom, sAlign){ return true; }; /** * Specifies how the floating object will be vertically aligned. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {RelFromV} [sRelativeFrom="page"] - The document element which will be taken as a countdown point for the object vertical alignment. * @param {("top" | "bottom" | "center")} [sAlign="top"] - The alingment type which will be used for the object vertical alignment. + * @returns {boolean} */ -ApiDrawing.prototype.SetVerAlign = function(sRelativeFrom, sAlign){}; +ApiDrawing.prototype.SetVerAlign = function(sRelativeFrom, sAlign){ return true; }; /** * Sets the absolute measurement for the horizontal positioning of the floating object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {RelFromH} sRelativeFrom - The document element which will be taken as a countdown point for the object horizontal alignment. * @param {EMU} nDistance - The distance from the right side of the document element to the floating object measured in English measure units. + * @returns {boolean} */ -ApiDrawing.prototype.SetHorPosition = function(sRelativeFrom, nDistance){}; +ApiDrawing.prototype.SetHorPosition = function(sRelativeFrom, nDistance){ return true; }; /** * Sets the absolute measurement for the vertical positioning of the floating object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {RelFromV} sRelativeFrom - The document element which will be taken as a countdown point for the object vertical alignment. * @param {EMU} nDistance - The distance from the bottom part of the document element to the floating object measured in English measure units. + * @returns {boolean} */ -ApiDrawing.prototype.SetVerPosition = function(sRelativeFrom, nDistance){}; +ApiDrawing.prototype.SetVerPosition = function(sRelativeFrom, nDistance){ return true; }; /** * Specifies the minimum distance which will be maintained between the edges of the current drawing object and any * subsequent text. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {EMU} nLeft - The distance from the left side of the current object and the subsequent text run measured in English measure units. * @param {EMU} nTop - The distance from the top side of the current object and the preceding text run measured in English measure units. * @param {EMU} nRight - The distance from the right side of the current object and the subsequent text run measured in English measure units. * @param {EMU} nBottom - The distance from the bottom side of the current object and the subsequent text run measured in English measure units. + * @returns {boolean} */ -ApiDrawing.prototype.SetDistances = function(nLeft, nTop, nRight, nBottom){}; +ApiDrawing.prototype.SetDistances = function(nLeft, nTop, nRight, nBottom){ return true; }; /** * Returns a parent paragraph that contains the graphic object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @returns {ApiParagraph | null} - returns null if parent paragraph doesn't exist. */ ApiDrawing.prototype.GetParentParagraph = function(){ return new ApiParagraph(); }; @@ -5739,7 +6329,6 @@ ApiDrawing.prototype.GetParentParagraph = function(){ return new ApiParagraph(); /** * Returns a parent content control that contains the graphic object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt | null} - returns null if parent content control doesn't exist. */ ApiDrawing.prototype.GetParentContentControl = function(){ return new ApiBlockLvlSdt(); }; @@ -5747,21 +6336,18 @@ ApiDrawing.prototype.GetParentContentControl = function(){ return new ApiBlockLv /** * Returns a parent table that contains the graphic object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null if parent table doesn't exist. */ ApiDrawing.prototype.GetParentTable = function(){ return new ApiTable(); }; /** * Returns a parent table cell that contains the graphic object. - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - returns null if parent cell doesn't exist. */ ApiDrawing.prototype.GetParentTableCell = function(){ return new ApiTableCell(); }; /** * Deletes the current graphic object. - * @typeofeditors ["CDE"] * @returns {boolean} - returns false if drawing object haven't parent. */ ApiDrawing.prototype.Delete = function(){ return true; }; @@ -5769,7 +6355,6 @@ ApiDrawing.prototype.Delete = function(){ return true; }; /** * Copies the current graphic object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @returns {ApiDrawing} */ ApiDrawing.prototype.Copy = function(){ return new ApiDrawing(); }; @@ -5777,7 +6362,6 @@ ApiDrawing.prototype.Copy = function(){ return new ApiDrawing(); }; /** * Wraps the graphic object with a rich text content control. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {number} nType - Defines if this method returns the ApiBlockLvlSdt (nType === 1) or ApiDrawing (any value except 1) object. * @returns {ApiDrawing | ApiBlockLvlSdt} */ @@ -5786,7 +6370,6 @@ ApiDrawing.prototype.InsertInContentControl = function(nType){ return new ApiDra /** * Inserts a paragraph at the specified position. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {string | ApiParagraph} paragraph - Text or paragraph. * @param {string} sPosition - The position where the text or paragraph will be inserted ("before" or "after" the drawing specified). * @param {boolean} beRNewPara - Defines if this method returns a new paragraph (true) or the current ApiDrawing (false). @@ -5797,14 +6380,13 @@ ApiDrawing.prototype.InsertParagraph = function(paragraph, sPosition, beRNewPara /** * Selects the current graphic object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiDrawing.prototype.Select = function(){}; +ApiDrawing.prototype.Select = function(){ return true; }; /** * Inserts a break at the specified location in the main document. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {number}breakType - The break type: page break (0) or line break (1). * @param {string}position - The position where the page or line break will be inserted ("before" or "after" the current drawing). * @returns {boolean} - returns false if drawing object haven't parent run or params are invalid. @@ -5814,15 +6396,14 @@ ApiDrawing.prototype.AddBreak = function(breakType, position){ return true; }; /** * Flips the current drawing horizontally. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {boolean} bFlip - Specifies if the figure will be flipped horizontally or not. + * @returns {boolean} */ -ApiDrawing.prototype.SetHorFlip = function(bFlip){}; +ApiDrawing.prototype.SetHorFlip = function(bFlip){ return true; }; /** * Flips the current drawing vertically. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {boolean} bFlip - Specifies if the figure will be flipped vertically or not. * @returns {boolean} - returns false if param is invalid. */ @@ -5831,7 +6412,6 @@ ApiDrawing.prototype.SetVertFlip = function(bFlip){ return true; }; /** * Scales the height of the figure using the specified coefficient. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {number} coefficient - The coefficient by which the figure height will be scaled. * @returns {boolean} - return false if param is invalid. */ @@ -5840,7 +6420,6 @@ ApiDrawing.prototype.ScaleHeight = function(coefficient){ return true; }; /** * Scales the width of the figure using the specified coefficient. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {number} coefficient - The coefficient by which the figure width will be scaled. * @returns {boolean} - return false if param is invali. */ @@ -5849,7 +6428,6 @@ ApiDrawing.prototype.ScaleWidth = function(coefficient){ return true; }; /** * Sets the fill formatting properties to the current graphic object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {ApiFill} oFill - The fill type used to fill the graphic object. * @returns {boolean} - returns false if param is invalid. */ @@ -5858,7 +6436,6 @@ ApiDrawing.prototype.Fill = function(oFill){ return true; }; /** * Sets the outline properties to the specified graphic object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {ApiStroke} oStroke - The stroke used to create the graphic object outline. * @returns {boolean} - returns false if param is invalid. */ @@ -5867,7 +6444,6 @@ ApiDrawing.prototype.SetOutLine = function(oStroke){ return true; }; /** * Returns the next inline drawing object if exists. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @returns {ApiDrawing | null} - returns null if drawing object is last. */ ApiDrawing.prototype.GetNextDrawing = function(){ return new ApiDrawing(); }; @@ -5875,7 +6451,6 @@ ApiDrawing.prototype.GetNextDrawing = function(){ return new ApiDrawing(); }; /** * Returns the previous inline drawing object if exists. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @returns {ApiDrawing | null} - returns null if drawing object is first. */ ApiDrawing.prototype.GetPrevDrawing = function(){ return new ApiDrawing(); }; @@ -5883,7 +6458,6 @@ ApiDrawing.prototype.GetPrevDrawing = function(){ return new ApiDrawing(); }; /** * Converts the ApiDrawing object into the JSON object. * @memberof ApiDrawing - * @typeofeditors ["CDE"] * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} @@ -5893,7 +6467,6 @@ ApiDrawing.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ return n /** * Returns the width of the current drawing. * @memberof ApiDrawing - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {EMU} */ ApiDrawing.prototype.GetWidth = function(){ return new EMU(); }; @@ -5901,27 +6474,22 @@ ApiDrawing.prototype.GetWidth = function(){ return new EMU(); }; /** * Returns the height of the current drawing. * @memberof ApiDrawing - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {EMU} */ ApiDrawing.prototype.GetHeight = function(){ return new EMU(); }; /** * Returns the lock value for the specified lock type of the current drawing. - * @typeofeditors ["CDE"] - * @param {"noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" - * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox"} sType - Lock type in the string format. - * @returns {bool} + * @param {DrawingLockType} sType - Lock type in the string format. + * @returns {boolean} */ ApiDrawing.prototype.GetLockValue = function(sType){ return true; }; /** * Sets the lock value to the specified lock type of the current drawing. - * @typeofeditors ["CDE"] - * @param {"noGrp" | "noUngrp" | "noSelect" | "noRot" | "noChangeAspect" | "noMove" | "noResize" | "noEditPoints" | "noAdjustHandles" - * | "noChangeArrowheads" | "noChangeShapeType" | "noDrilldown" | "noTextEdit" | "noCrop" | "txBox"} sType - Lock type in the string format. - * @param {bool} bValue - Specifies if the specified lock is applied to the current drawing. - * @returns {bool} + * @param {DrawingLockType} sType - Lock type in the string format. + * @param {boolean} bValue - Specifies if the specified lock is applied to the current drawing. + * @returns {boolean} */ ApiDrawing.prototype.SetLockValue = function(sType, bValue){ return true; }; @@ -5930,15 +6498,30 @@ ApiDrawing.prototype.SetLockValue = function(sType, bValue){ return true; }; * The following properties will be copied: horizontal and vertical alignment, distance between the edges of the current drawing object and any subsequent text, wrapping style, drawing name, title and description. * @memberof ApiDrawing * @param {ApiDrawing} oAnotherDrawing - The drawing which properties will be set to the current drawing. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiDrawing.prototype.SetDrawingPrFromDrawing = function(oAnotherDrawing){ return true; }; +/** + * Sets the rotation angle to the current drawing object. + * @memberof ApiDrawing + * @param {number} nRotAngle - New drawing rotation angle. + * @returns {boolean} + * @since 9.0.0 + */ +ApiDrawing.prototype.SetRotation = function(nRotAngle){ return true; }; + +/** + * Returns the rotation angle of the current drawing object. + * @memberof ApiDrawing + * @returns {number} + * @since 9.0.0 + */ +ApiDrawing.prototype.GetRotation = function(){ return 0; }; + /** * Returns a type of the ApiImage class. * @memberof ApiImage - * @typeofeditors ["CDE", "CPE"] * @returns {"image"} */ ApiImage.prototype.GetClassType = function(){ return ""; }; @@ -5946,7 +6529,6 @@ ApiImage.prototype.GetClassType = function(){ return ""; }; /** * Returns the next inline image if exists. * @memberof ApiImage - * @typeofeditors ["CDE"] * @returns {ApiImage | null} - returns null if image is last. */ ApiImage.prototype.GetNextImage= function(){ return new ApiImage(); }; @@ -5954,7 +6536,6 @@ ApiImage.prototype.GetNextImage= function(){ return new ApiImage(); }; /** * Returns the previous inline image if exists. * @memberof ApiImage - * @typeofeditors ["CDE"] * @returns {ApiImage | null} - returns null if image is first. */ ApiImage.prototype.GetPrevImage= function(){ return new ApiImage(); }; @@ -5962,7 +6543,6 @@ ApiImage.prototype.GetPrevImage= function(){ return new ApiImage(); }; /** * Returns a type of the ApiOleObject class. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {"oleObject"} */ ApiOleObject.prototype.GetClassType = function(){ return ""; }; @@ -5970,7 +6550,6 @@ ApiOleObject.prototype.GetClassType = function(){ return ""; }; /** * Sets the data to the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {string} sData - The OLE object string data. * @returns {boolean} */ @@ -5979,7 +6558,6 @@ ApiOleObject.prototype.SetData = function(sData){ return true; }; /** * Returns the string data from the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiOleObject.prototype.GetData = function(){ return ""; }; @@ -5987,7 +6565,6 @@ ApiOleObject.prototype.GetData = function(){ return ""; }; /** * Sets the application ID to the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {string} sAppId - The application ID associated with the curent OLE object. * @returns {boolean} */ @@ -5996,7 +6573,6 @@ ApiOleObject.prototype.SetApplicationId = function(sAppId){ return true; }; /** * Returns the application ID from the current OLE object. * @memberof ApiOleObject - * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} */ ApiOleObject.prototype.GetApplicationId = function(){ return ""; }; @@ -6004,7 +6580,6 @@ ApiOleObject.prototype.GetApplicationId = function(){ return ""; }; /** * Returns a type of the ApiShape class. * @memberof ApiShape - * @typeofeditors ["CDE", "CSE"] * @returns {"shape"} */ ApiShape.prototype.GetClassType = function(){ return ""; }; @@ -6012,42 +6587,32 @@ ApiShape.prototype.GetClassType = function(){ return ""; }; /** * Returns the shape inner contents where a paragraph or text runs can be inserted. * @memberof ApiShape - * @typeofeditors ["CDE", "CSE"] * @returns {ApiDocumentContent} */ ApiShape.prototype.GetDocContent = function(){ return new ApiDocumentContent(); }; -/** - * Returns the shape inner contents where a paragraph or text runs can be inserted. - * @memberof ApiShape - * @typeofeditors ["CDE", "CSE"] - * @returns {ApiDocumentContent} - */ -ApiShape.prototype.GetContent = function(){ return new ApiDocumentContent(); }; - /** * Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. * @memberof ApiShape - * @typeofeditors ["CDE", "CSE"] * @param {VerticalTextAlign} VerticalAlign - The type of the vertical alignment for the shape inner contents. + * @returns {boolean} */ -ApiShape.prototype.SetVerticalTextAlign = function(VerticalAlign){}; +ApiShape.prototype.SetVerticalTextAlign = function(VerticalAlign){ return true; }; /** * Sets the text paddings to the current shape. * @memberof ApiShape - * @typeofeditors ["CDE", "CSE"] * @param {?EMU} nLeft - Left padding. * @param {?EMU} nTop - Top padding. * @param {?EMU} nRight - Right padding. * @param {?EMU} nBottom - Bottom padding. + * @returns {boolean} */ -ApiShape.prototype.SetPaddings = function(nLeft, nTop, nRight, nBottom){}; +ApiShape.prototype.SetPaddings = function(nLeft, nTop, nRight, nBottom){ return true; }; /** * Returns the next inline shape if exists. * @memberof ApiShape - * @typeofeditors ["CDE"] * @returns {ApiShape | null} - returns null if shape is last. */ ApiShape.prototype.GetNextShape = function(){ return new ApiShape(); }; @@ -6055,7 +6620,6 @@ ApiShape.prototype.GetNextShape = function(){ return new ApiShape(); }; /** * Returns the previous inline shape if exists. * @memberof ApiShape - * @typeofeditors ["CDE"] * @returns {ApiShape | null} - returns null is shape is first. */ ApiShape.prototype.GetPrevShape= function(){ return new ApiShape(); }; @@ -6063,197 +6627,202 @@ ApiShape.prototype.GetPrevShape= function(){ return new ApiShape(); }; /** * Returns a type of the ApiChart class. * @memberof ApiChart - * @typeofeditors ["CDE"] * @returns {"chart"} */ ApiChart.prototype.GetClassType = function(){ return ""; }; +/** + * Returns a type of the chart object. + * @memberof ApiChart + * @returns {ChartType} + */ +ApiChart.prototype.GetChartType = function(){ return new ChartType(); }; + /** * Specifies the chart title. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {string} sTitle - The title which will be displayed for the current chart. * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the chart title is written in bold font or not. + * @param {boolean} bIsBold - Specifies if the chart title is written in bold font or not. + * @returns {boolean} */ -ApiChart.prototype.SetTitle = function (sTitle, nFontSize, bIsBold){}; +ApiChart.prototype.SetTitle = function (sTitle, nFontSize, bIsBold){ return true; }; /** * Specifies the chart horizontal axis title. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {string} sTitle - The title which will be displayed for the horizontal axis of the current chart. * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the horizontal axis title is written in bold font or not. - * */ -ApiChart.prototype.SetHorAxisTitle = function (sTitle, nFontSize, bIsBold){}; + * @param {boolean} bIsBold - Specifies if the horizontal axis title is written in bold font or not. + *@returns {boolean} + */ +ApiChart.prototype.SetHorAxisTitle = function (sTitle, nFontSize, bIsBold){ return true; }; /** * Specifies the chart vertical axis title. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {string} sTitle - The title which will be displayed for the vertical axis of the current chart. * @param {pt} nFontSize - The text size value measured in points. - * @param {?bool} bIsBold - Specifies if the vertical axis title is written in bold font or not. - * */ -ApiChart.prototype.SetVerAxisTitle = function (sTitle, nFontSize, bIsBold){}; + * @param {boolean} bIsBold - Specifies if the vertical axis title is written in bold font or not. + *@returns {boolean} + */ +ApiChart.prototype.SetVerAxisTitle = function (sTitle, nFontSize, bIsBold){ return true; }; /** * Specifies the vertical axis orientation. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {boolean} bIsMinMax - The true value will set the normal data direction for the vertical axis (from minimum to maximum). - * */ -ApiChart.prototype.SetVerAxisOrientation = function(bIsMinMax){}; + * @returns {boolean} + */ +ApiChart.prototype.SetVerAxisOrientation = function(bIsMinMax){ return true; }; /** * Specifies the horizontal axis orientation. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {boolean} bIsMinMax - The true value will set the normal data direction for the horizontal axis (from minimum to maximum). - * */ -ApiChart.prototype.SetHorAxisOrientation = function(bIsMinMax){}; + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisOrientation = function(bIsMinMax){ return true; }; /** * Specifies the chart legend position. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {"left" | "top" | "right" | "bottom" | "none"} sLegendPos - The position of the chart legend inside the chart window. - * */ -ApiChart.prototype.SetLegendPos = function(sLegendPos){}; + * @returns {boolean} + */ +ApiChart.prototype.SetLegendPos = function(sLegendPos){ return true; }; /** * Specifies the legend font size. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {pt} nFontSize - The text size value measured in points. - * */ -ApiChart.prototype.SetLegendFontSize = function(nFontSize){}; + * @returns {boolean} + */ +ApiChart.prototype.SetLegendFontSize = function(nFontSize){ return true; }; /** * Specifies which chart data labels are shown for the chart. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. * @param {boolean} bShowVal - Whether to show or hide the chart data values. * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). - * */ -ApiChart.prototype.SetShowDataLabels = function(bShowSerName, bShowCatName, bShowVal, bShowPercent){}; + * @returns {boolean} + */ +ApiChart.prototype.SetShowDataLabels = function(bShowSerName, bShowCatName, bShowVal, bShowPercent){ return true; }; /** * Spicifies the show options for data labels. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {number} nSeriesIndex - The series index from the array of the data used to build the chart from. * @param {number} nPointIndex - The point index from this series. * @param {boolean} bShowSerName - Whether to show or hide the source table column names used for the data which the chart will be build from. * @param {boolean} bShowCatName - Whether to show or hide the source table row names used for the data which the chart will be build from. * @param {boolean} bShowVal - Whether to show or hide the chart data values. * @param {boolean} bShowPercent - Whether to show or hide the percent for the data values (works with stacked chart types). - * */ -ApiChart.prototype.SetShowPointDataLabel = function(nSeriesIndex, nPointIndex, bShowSerName, bShowCatName, bShowVal, bShowPercent){}; + * @returns {boolean} + */ +ApiChart.prototype.SetShowPointDataLabel = function(nSeriesIndex, nPointIndex, bShowSerName, bShowCatName, bShowVal, bShowPercent){ return true; }; /** * Spicifies tick labels position for the vertical axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart vertical tick labels. - * */ -ApiChart.prototype.SetVertAxisTickLabelPosition = function(sTickLabelPosition){}; + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisTickLabelPosition = function(sTickLabelPosition){ return true; }; /** * Spicifies tick labels position for the horizontal axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {TickLabelPosition} sTickLabelPosition - The type for the position of chart horizontal tick labels. - * */ -ApiChart.prototype.SetHorAxisTickLabelPosition = function(sTickLabelPosition){}; + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisTickLabelPosition = function(sTickLabelPosition){ return true; }; /** * Specifies major tick mark for the horizontal axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetHorAxisMajorTickMark = function(sTickMark){}; + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisMajorTickMark = function(sTickMark){ return true; }; /** * Specifies minor tick mark for the horizontal axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetHorAxisMinorTickMark = function(sTickMark){}; + * @returns {boolean} + */ +ApiChart.prototype.SetHorAxisMinorTickMark = function(sTickMark){ return true; }; /** * Specifies major tick mark for the vertical axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetVertAxisMajorTickMark = function(sTickMark){}; + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisMajorTickMark = function(sTickMark){ return true; }; /** * Specifies minor tick mark for the vertical axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {TickMark} sTickMark - The type of tick mark appearance. - * */ -ApiChart.prototype.SetVertAxisMinorTickMark = function(sTickMark){}; + * @returns {boolean} + */ +ApiChart.prototype.SetVertAxisMinorTickMark = function(sTickMark){ return true; }; /** * Specifies major vertical gridline visual properties. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMajorVerticalGridlines = function(oStroke){}; + * @returns {boolean} + */ +ApiChart.prototype.SetMajorVerticalGridlines = function(oStroke){ return true; }; /** * Specifies minor vertical gridline visual properties. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMinorVerticalGridlines = function(oStroke){}; + * @returns {boolean} + */ +ApiChart.prototype.SetMinorVerticalGridlines = function(oStroke){ return true; }; /** * Specifies major horizontal gridline visual properties. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMajorHorizontalGridlines = function(oStroke){}; + * @returns {boolean} + */ +ApiChart.prototype.SetMajorHorizontalGridlines = function(oStroke){ return true; }; /** * Specifies minor horizontal gridline visual properties. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {?ApiStroke} oStroke - The stroke used to create the element shadow. - * */ -ApiChart.prototype.SetMinorHorizontalGridlines = function(oStroke){}; + * @returns {boolean} + */ +ApiChart.prototype.SetMinorHorizontalGridlines = function(oStroke){ return true; }; /** * Specifies font size for labels of the horizontal axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {pt} nFontSize - The text size value measured in points. + * @returns {boolean} */ -ApiChart.prototype.SetHorAxisLablesFontSize = function(nFontSize){}; +ApiChart.prototype.SetHorAxisLablesFontSize = function(nFontSize){ return true; }; /** * Specifies font size for labels of the vertical axis. * @memberof ApiChart - * @typeofeditors ["CDE"] * @param {pt} nFontSize - The text size value measured in points. + * @returns {boolean} */ -ApiChart.prototype.SetVertAxisLablesFontSize = function(nFontSize){}; +ApiChart.prototype.SetVertAxisLablesFontSize = function(nFontSize){ return true; }; /** * Returns the next inline chart if exists. * @memberof ApiChart - * @typeofeditors ["CDE"] * @returns {ApiChart | null} - returns null if chart is last. */ ApiChart.prototype.GetNextChart = function(){ return new ApiChart(); }; @@ -6261,7 +6830,6 @@ ApiChart.prototype.GetNextChart = function(){ return new ApiChart(); }; /** * Returns the previous inline chart if exists. * @memberof ApiChart - * @typeofeditors ["CDE"] * @returns {ApiChart | null} - return null if char if first. */ ApiChart.prototype.GetPrevChart= function(){ return new ApiChart(); }; @@ -6269,7 +6837,6 @@ ApiChart.prototype.GetPrevChart= function(){ return new ApiChart(); }; /** * Removes the specified series from the current chart. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {number} nSeria - The index of the chart series. * @returns {boolean} */ @@ -6278,7 +6845,6 @@ ApiChart.prototype.RemoveSeria = function(nSeria){ return true; }; /** * Sets values to the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] * @param {number[]} aValues - The array of the data which will be set to the specified chart series. * @param {number} nSeria - The index of the chart series. * @returns {boolean} @@ -6288,7 +6854,6 @@ ApiChart.prototype.SetSeriaValues = function(aValues, nSeria){ return true; }; /** * Sets the x-axis values to all chart series. It is used with the scatter charts only. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] * @param {string[]} aValues - The array of the data which will be set to the x-axis data points. * @returns {boolean} */ @@ -6297,7 +6862,6 @@ ApiChart.prototype.SetXValues = function(aValues){ return true; }; /** * Sets a name to the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] * @param {string} sName - The name which will be set to the specified chart series. * @param {number} nSeria - The index of the chart series. * @returns {boolean} @@ -6307,7 +6871,6 @@ ApiChart.prototype.SetSeriaName = function(sName, nSeria){ return true; }; /** * Sets a name to the specified chart category. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] * @param {string} sName - The name which will be set to the specified chart category. * @param {number} nCategory - The index of the chart category. * @returns {boolean} @@ -6317,7 +6880,6 @@ ApiChart.prototype.SetCategoryName = function(sName, nCategory){ return true; }; /** * Sets a style to the current chart by style ID. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param nStyleId - One of the styles available in the editor. * @returns {boolean} */ @@ -6326,7 +6888,6 @@ ApiChart.prototype.ApplyChartStyle = function(nStyleId){ return true; }; /** * Sets the fill to the chart plot area. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiFill} oFill - The fill type used to fill the plot area. * @returns {boolean} */ @@ -6335,7 +6896,6 @@ ApiChart.prototype.SetPlotAreaFill = function(oFill){ return true; }; /** * Sets the outline to the chart plot area. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the plot area outline. * @returns {boolean} */ @@ -6344,7 +6904,6 @@ ApiChart.prototype.SetPlotAreaOutLine = function(oStroke){ return true; }; /** * Sets the fill to the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiFill} oFill - The fill type used to fill the series. * @param {number} nSeries - The index of the chart series. * @param {boolean} [bAll=false] - Specifies if the fill will be applied to all series. @@ -6355,7 +6914,6 @@ ApiChart.prototype.SetSeriesFill = function(oFill, nSeries, bAll){ return true; /** * Sets the outline to the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the series outline. * @param {number} nSeries - The index of the chart series. * @param {boolean} [bAll=false] - Specifies if the outline will be applied to all series. @@ -6366,7 +6924,6 @@ ApiChart.prototype.SetSeriesOutLine = function(oStroke, nSeries, bAll){ return t /** * Sets the fill to the data point in the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiFill} oFill - The fill type used to fill the data point. * @param {number} nSeries - The index of the chart series. * @param {number} nDataPoint - The index of the data point in the specified chart series. @@ -6378,7 +6935,6 @@ ApiChart.prototype.SetDataPointFill = function(oFill, nSeries, nDataPoint, bAllS /** * Sets the outline to the data point in the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the data point outline. * @param {number} nSeries - The index of the chart series. * @param {number} nDataPoint - The index of the data point in the specified chart series. @@ -6390,7 +6946,6 @@ ApiChart.prototype.SetDataPointOutLine = function(oStroke, nSeries, nDataPoint, /** * Sets the fill to the marker in the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiFill} oFill - The fill type used to fill the marker. * @param {number} nSeries - The index of the chart series. * @param {number} nMarker - The index of the marker in the specified chart series. @@ -6402,7 +6957,6 @@ ApiChart.prototype.SetMarkerFill = function(oFill, nSeries, nMarker, bAllMarkers /** * Sets the outline to the marker in the specified chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the marker outline. * @param {number} nSeries - The index of the chart series. * @param {number} nMarker - The index of the marker in the specified chart series. @@ -6414,7 +6968,6 @@ ApiChart.prototype.SetMarkerOutLine = function(oStroke, nSeries, nMarker, bAllMa /** * Sets the fill to the chart title. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiFill} oFill - The fill type used to fill the title. * @returns {boolean} */ @@ -6423,7 +6976,6 @@ ApiChart.prototype.SetTitleFill = function(oFill){ return true; }; /** * Sets the outline to the chart title. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the title outline. * @returns {boolean} */ @@ -6432,7 +6984,6 @@ ApiChart.prototype.SetTitleOutLine = function(oStroke){ return true; }; /** * Sets the fill to the chart legend. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiFill} oFill - The fill type used to fill the legend. * @returns {boolean} */ @@ -6441,7 +6992,6 @@ ApiChart.prototype.SetLegendFill = function(oFill){ return true; }; /** * Sets the outline to the chart legend. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {ApiStroke} oStroke - The stroke used to create the legend outline. * @returns {boolean} */ @@ -6450,7 +7000,6 @@ ApiChart.prototype.SetLegendOutLine = function(oStroke){ return true; }; /** * Sets the specified numeric format to the axis values. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE", "CSE"] * @param {NumFormat | String} sFormat - Numeric format (can be custom format). * @param {AxisPos} - Axis position in the chart. * @returns {boolean} @@ -6460,7 +7009,6 @@ ApiChart.prototype.SetAxieNumFormat = function(sFormat, sAxiePos){ return true; /** * Sets the specified numeric format to the chart series. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] * @param {NumFormat | String} sFormat - Numeric format (can be custom format). * @param {Number} nSeria - Series index. * @returns {boolean} @@ -6470,7 +7018,6 @@ ApiChart.prototype.SetSeriaNumFormat = function(sFormat, nSeria){ return true; } /** * Sets the specified numeric format to the chart data point. * @memberof ApiChart - * @typeofeditors ["CDE", "CPE"] * @param {NumFormat | String} sFormat - Numeric format (can be custom format). * @param {Number} nSeria - Series index. * @param {number} nDataPoint - The index of the data point in the specified chart series. @@ -6479,10 +7026,62 @@ ApiChart.prototype.SetSeriaNumFormat = function(sFormat, nSeria){ return true; } */ ApiChart.prototype.SetDataPointNumFormat = function(sFormat, nSeria, nDataPoint, bAllSeries){ return true; }; +/** + * Returns all series from the chart space. + * @memberof ApiChart + * @returns {ApiChartSeries[]} + */ +ApiChart.prototype.GetAllSeries = function(){ return [new ApiChartSeries()]; }; + +/** + * Returns the series with a specific index. + * @memberof ApiChart + * @param {number} nIdx - Series index. + * @returns {ApiChartSeries} + */ +ApiChart.prototype.GetSeries = function(nIdx){ return new ApiChartSeries(); }; + +/** + * Returns a type of the ApiChartSeries class. + * @memberof ApiChartSeries + * @returns {"chartSeries"} + */ +ApiChartSeries.prototype.GetClassType = function(){ return ""; }; + +/** + * Tries to change the series type. Returns true if successful. + * @memberof ApiChartSeries + * @param {ChartType} sType - Chart type. + * @returns {boolean} + */ +ApiChartSeries.prototype.ChangeChartType = function(sType){ return true; }; + +/** + * Returns a chart type of the current series. + * @memberof ApiChartSeries + * @returns {ChartType} + */ +ApiChartSeries.prototype.GetChartType = function(){ return new ChartType(); }; + +/** + * Returns a type of the ApiGroup class. + * @memberof ApiGroup + * @returns {"group"} + * @since 8.3.0 + */ +ApiGroup.prototype.GetClassType = function(){ return ""; }; + +/** + * Ungroups the current group of drawings. + * @memberof ApiGroup + * @returns {boolean} + * @since 8.3.0 + */ +ApiGroup.prototype.Ungroup = function(){ return true; }; + /** * Returns a type of the ApiFill class. * @memberof ApiFill - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"fill"} */ ApiFill.prototype.GetClassType = function(){ return ""; }; @@ -6490,7 +7089,6 @@ ApiFill.prototype.GetClassType = function(){ return ""; }; /** * Converts the ApiFill object into the JSON object. * @memberof ApiFill - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiFill.prototype.ToJSON = function(){ return new JSON(); }; @@ -6498,7 +7096,6 @@ ApiFill.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiStroke class. * @memberof ApiStroke - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"stroke"} */ ApiStroke.prototype.GetClassType = function(){ return ""; }; @@ -6506,7 +7103,6 @@ ApiStroke.prototype.GetClassType = function(){ return ""; }; /** * Converts the ApiStroke object into the JSON object. * @memberof ApiStroke - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiStroke.prototype.ToJSON = function(){ return new JSON(); }; @@ -6514,7 +7110,6 @@ ApiStroke.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiGradientStop class. * @memberof ApiGradientStop - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"gradientStop"} */ ApiGradientStop.prototype.GetClassType = function (){ return ""; }; @@ -6522,7 +7117,6 @@ ApiGradientStop.prototype.GetClassType = function (){ return ""; }; /** * Converts the ApiGradientStop object into the JSON object. * @memberof ApiGradientStop - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiGradientStop.prototype.ToJSON = function(){ return new JSON(); }; @@ -6530,7 +7124,6 @@ ApiGradientStop.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiUniColor class. * @memberof ApiUniColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"uniColor"} */ ApiUniColor.prototype.GetClassType = function (){ return ""; }; @@ -6538,15 +7131,20 @@ ApiUniColor.prototype.GetClassType = function (){ return ""; }; /** * Converts the ApiUniColor object into the JSON object. * @memberof ApiUniColor - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiUniColor.prototype.ToJSON = function(){ return new JSON(); }; +/** + * Returns a color value in RGB format. + * @memberof ApiUniColor + * @returns {number} + */ +ApiUniColor.prototype.GetRGB = function(){ return 0; }; + /** * Returns a type of the ApiRGBColor class. * @memberof ApiRGBColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"rgbColor"} */ ApiRGBColor.prototype.GetClassType = function (){ return ""; }; @@ -6554,7 +7152,6 @@ ApiRGBColor.prototype.GetClassType = function (){ return ""; }; /** * Converts the ApiRGBColor object into the JSON object. * @memberof ApiRGBColor - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiRGBColor.prototype.ToJSON = function(){ return new JSON(); }; @@ -6562,7 +7159,6 @@ ApiRGBColor.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiSchemeColor class. * @memberof ApiSchemeColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"schemeColor"} */ ApiSchemeColor.prototype.GetClassType = function (){ return ""; }; @@ -6570,7 +7166,6 @@ ApiSchemeColor.prototype.GetClassType = function (){ return ""; }; /** * Converts the ApiSchemeColor object into the JSON object. * @memberof ApiSchemeColor - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiSchemeColor.prototype.ToJSON = function(){ return new JSON(); }; @@ -6578,7 +7173,6 @@ ApiSchemeColor.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiPresetColor class. * @memberof ApiPresetColor - * @typeofeditors ["CDE", "CSE", "CPE"] * @returns {"presetColor"} */ ApiPresetColor.prototype.GetClassType = function (){ return ""; }; @@ -6586,7 +7180,6 @@ ApiPresetColor.prototype.GetClassType = function (){ return ""; }; /** * Converts the ApiPresetColor object into the JSON object. * @memberof ApiPresetColor - * @typeofeditors ["CDE"] * @returns {JSON} */ ApiPresetColor.prototype.ToJSON = function(){ return new JSON(); }; @@ -6594,26 +7187,49 @@ ApiPresetColor.prototype.ToJSON = function(){ return new JSON(); }; /** * Returns a type of the ApiInlineLvlSdt class. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {"inlineLvlSdt"} */ ApiInlineLvlSdt.prototype.GetClassType = function(){ return ""; }; +/** + * Returns an internal ID of the current content control. + * @memberof ApiInlineLvlSdt + * @returns {string} + */ +ApiInlineLvlSdt.prototype.GetInternalId = function(){ return ""; }; + +/** + * Specifies a unique ID for the current content control. + * @memberof ApiInlineLvlSdt + * @since 8.3.2 + * @param {number} id - The numerical ID which will be specified for the current content control. + * @returns {boolean} + */ +ApiInlineLvlSdt.prototype.SetId = function(id){ return true; }; + +/** + * Returns a unique ID for the current content control. + * @memberof ApiInlineLvlSdt + * @since 8.3.2 + * @returns {string} + */ +ApiInlineLvlSdt.prototype.GetId = function(){ return ""; }; + /** * Sets the lock to the current inline text content control: + * "unlocked" - content can be edited and the container can be deleted. * "contentLocked" - content cannot be edited. * "sdtContentLocked" - content cannot be edited and the container cannot be deleted. * "sdtLocked" - the container cannot be deleted. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] - * @param {"contentLocked" | "sdtContentLocked" | "sdtLocked"} sLockType - The lock type applied to the inline text content control. + * @param {"unlocked" | "contentLocked" | "sdtContentLocked" | "sdtLocked"} lockType - The lock type applied to the inline text content control. + * @returns {boolean} */ -ApiInlineLvlSdt.prototype.SetLock = function(sLockType){}; +ApiInlineLvlSdt.prototype.SetLock = function(lockType){ return true; }; /** * Returns the lock type of the current container. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {SdtLock} */ ApiInlineLvlSdt.prototype.GetLock = function(){ return new SdtLock(); }; @@ -6621,15 +7237,14 @@ ApiInlineLvlSdt.prototype.GetLock = function(){ return new SdtLock(); }; /** * Adds a string tag to the current inline text content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {string} sTag - The tag which will be added to the current inline text content control. + * @returns {boolean} */ -ApiInlineLvlSdt.prototype.SetTag = function(sTag){}; +ApiInlineLvlSdt.prototype.SetTag = function(sTag){ return true; }; /** * Returns the tag attribute for the current container. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiInlineLvlSdt.prototype.GetTag = function(){ return ""; }; @@ -6637,15 +7252,14 @@ ApiInlineLvlSdt.prototype.GetTag = function(){ return ""; }; /** * Adds a string label to the current inline text content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {string} sLabel - The label which will be added to the current inline text content control. Can be a positive or negative integer from -2147483647 to 2147483647. + * @returns {boolean} */ -ApiInlineLvlSdt.prototype.SetLabel = function(sLabel){}; +ApiInlineLvlSdt.prototype.SetLabel = function(sLabel){ return true; }; /** * Returns the label attribute for the current container. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiInlineLvlSdt.prototype.GetLabel = function(){ return ""; }; @@ -6653,15 +7267,14 @@ ApiInlineLvlSdt.prototype.GetLabel = function(){ return ""; }; /** * Sets the alias attribute to the current container. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {string} sAlias - The alias which will be added to the current inline text content control. + * @returns {boolean} */ -ApiInlineLvlSdt.prototype.SetAlias = function(sAlias){}; +ApiInlineLvlSdt.prototype.SetAlias = function(sAlias){ return true; }; /** * Returns the alias attribute for the current container. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiInlineLvlSdt.prototype.GetAlias = function(){ return ""; }; @@ -6671,7 +7284,6 @@ ApiInlineLvlSdt.prototype.GetAlias = function(){ return ""; }; * control is created with one text run present in it by default, so even without any * element added this method will return the value of '1'. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {number} */ ApiInlineLvlSdt.prototype.GetElementsCount = function(){ return 0; }; @@ -6679,7 +7291,6 @@ ApiInlineLvlSdt.prototype.GetElementsCount = function(){ return 0; }; /** * Returns an element of the current inline text content control using the position specified. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {number} nPos - The position where the element which content we want to get must be located. * @returns {ParagraphContent} */ @@ -6688,7 +7299,6 @@ ApiInlineLvlSdt.prototype.GetElement = function(nPos){ return new ParagraphConte /** * Removes an element using the position specified from the current inline text content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {number} nPos - The position of the element which we want to remove from the current inline text content control. * @returns {boolean} */ @@ -6697,7 +7307,6 @@ ApiInlineLvlSdt.prototype.RemoveElement = function(nPos){ return true; }; /** * Removes all the elements from the current inline text content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {boolean} - returns false if control has not elements. */ ApiInlineLvlSdt.prototype.RemoveAllElements = function(){ return true; }; @@ -6705,7 +7314,6 @@ ApiInlineLvlSdt.prototype.RemoveAllElements = function(){ return true; }; /** * Adds an element to the inline text content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {ParagraphContent} oElement - The document element which will be added at the position specified. Returns false if the type of *oElement* is not supported by an inline text content control. * @param {number} [nPos] - The position of the element where it will be added to the current inline text content control. If this value is not specified, then the element will be added to the end of the current inline text content control. * @returns {boolean} - returns false if oElement unsupported. @@ -6715,7 +7323,6 @@ ApiInlineLvlSdt.prototype.AddElement = function(oElement, nPos){ return true; }; /** * Adds an element to the end of inline text content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {DocumentElement} oElement - The document element which will be added to the end of the container. * @returns {boolean} - returns false if oElement unsupported. */ @@ -6724,7 +7331,6 @@ ApiInlineLvlSdt.prototype.Push = function(oElement){ return true; }; /** * Adds text to the current content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {String} sText - The text which will be added to the content control. * @returns {boolean} - returns false if param is invalid. */ @@ -6733,7 +7339,6 @@ ApiInlineLvlSdt.prototype.AddText = function(sText){ return true; }; /** * Removes a content control and its content. If keepContent is true, the content is not deleted. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {boolean} keepContent - Specifies if the content will be deleted or not. * @returns {boolean} - returns false if control haven't parent paragraph. */ @@ -6742,7 +7347,6 @@ ApiInlineLvlSdt.prototype.Delete = function(keepContent){ return true; }; /** * Applies text settings to the content of the content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {ApiTextPr} oTextPr - The properties that will be set to the content of the content control. * @returns {ApiInlineLvlSdt} this. */ @@ -6751,7 +7355,6 @@ ApiInlineLvlSdt.prototype.SetTextPr = function(oTextPr){ return new ApiInlineLvl /** * Returns a paragraph that contains the current content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiParagraph | null} - returns null if parent paragraph doesn't exist. */ ApiInlineLvlSdt.prototype.GetParentParagraph = function(){ return new ApiParagraph(); }; @@ -6759,7 +7362,6 @@ ApiInlineLvlSdt.prototype.GetParentParagraph = function(){ return new ApiParagra /** * Returns a content control that contains the current content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt | ApiInlineLvlSdt | null} - returns null if parent content control doesn't exist. */ ApiInlineLvlSdt.prototype.GetParentContentControl = function(){ return new ApiBlockLvlSdt(); }; @@ -6767,7 +7369,6 @@ ApiInlineLvlSdt.prototype.GetParentContentControl = function(){ return new ApiBl /** * Returns a table that contains the current content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null if parent table doesn't exist. */ ApiInlineLvlSdt.prototype.GetParentTable = function(){ return new ApiTable(); }; @@ -6775,7 +7376,6 @@ ApiInlineLvlSdt.prototype.GetParentTable = function(){ return new ApiTable(); }; /** * Returns a table cell that contains the current content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - return null if parent cell doesn't exist. */ ApiInlineLvlSdt.prototype.GetParentTableCell = function(){ return new ApiTableCell(); }; @@ -6783,17 +7383,15 @@ ApiInlineLvlSdt.prototype.GetParentTableCell = function(){ return new ApiTableCe /** * Returns a Range object that represents the part of the document contained in the specified content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character in the current element. - * @param {Number} End - End character in the current element. + * @param {Number} Start - Start position index in the current element. + * @param {Number} End - End position index in the current element. * @returns {ApiRange} - * */ + */ ApiInlineLvlSdt.prototype.GetRange = function(Start, End){ return new ApiRange(); }; /** * Creates a copy of an inline content control. Ignores comments, footnote references, complex fields. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiInlineLvlSdt} */ ApiInlineLvlSdt.prototype.Copy = function(){ return new ApiInlineLvlSdt(); }; @@ -6801,7 +7399,6 @@ ApiInlineLvlSdt.prototype.Copy = function(){ return new ApiInlineLvlSdt(); }; /** * Converts the ApiInlineLvlSdt object into the JSON object. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} */ @@ -6810,17 +7407,15 @@ ApiInlineLvlSdt.prototype.ToJSON = function(bWriteStyles){ return new JSON(); }; /** * Returns the placeholder text from the current inline content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiInlineLvlSdt.prototype.GetPlaceholderText = function(){ return ""; }; /** * Sets the placeholder text to the current inline content control. - * *Can't be set to checkbox or radio button* + *Can't be set to checkbox or radio button* * @memberof ApiInlineLvlSdt * @param {string} sText - The text that will be set to the current inline content control. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiInlineLvlSdt.prototype.SetPlaceholderText = function(sText){ return true; }; @@ -6828,7 +7423,6 @@ ApiInlineLvlSdt.prototype.SetPlaceholderText = function(sText){ return true; }; /** * Checks if the content control is a form. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiInlineLvlSdt.prototype.IsForm = function(){ return true; }; @@ -6837,85 +7431,319 @@ ApiInlineLvlSdt.prototype.IsForm = function(){ return true; }; * Adds a comment to the current inline content control. * Please note that this inline content control must be in the document. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). + * @param {string} sText - The comment text. + * @param {string} [sAuthor] - The author's name. + * @param {string} [sUserId] - The user ID of the comment author. * @returns {ApiComment} - Returns null if the comment was not added. */ ApiInlineLvlSdt.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; /** - * Place cursor before/after the current content control - * @param {boolean} [isAfter=true] + * Places a cursor before/after the current content control. + * @param {boolean} [isAfter=true] - Specifies whether a cursor will be placed before (false) or after (true) the current content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] + * @returns {boolean} + * @since 8.1.0 */ -ApiInlineLvlSdt.prototype.MoveCursorOutside = function(isAfter){}; +ApiInlineLvlSdt.prototype.MoveCursorOutside = function(isAfter){ return true; }; /** - * Returns a list of values of the combo box / dropdown list content control. + * Returns a list of values of the combo box / drop-down list content control. * @memberof ApiInlineLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiContentControlList} */ ApiInlineLvlSdt.prototype.GetDropdownList = function(){ return new ApiContentControlList(); }; +/** + * Sets the border color to the current content control. + * @memberof ApiInlineLvlSdt + * @param {byte} r - Red color component value. + * @param {byte} g - Green color component value. + * @param {byte} b - Blue color component value. + * @param {byte} a - Alpha color component value. + * @since 8.3.2 + * @returns {boolean} + */ +ApiInlineLvlSdt.prototype.SetBorderColor = function(r, g, b, a){ return true; }; + +/** + * Returns the border color of the current content control. + * @memberof ApiInlineLvlSdt + * @since 8.3.2 + * @returns {null | {r:byte, g:byte, b:byte, a:byte}} + */ +ApiInlineLvlSdt.prototype.GetBorderColor = function(){ return null; }; + +/** + * Sets the background color to the current content control. + * @memberof ApiInlineLvlSdt + * @param {byte} r - Red color component value. + * @param {byte} g - Green color component value. + * @param {byte} b - Blue color component value. + * @param {byte} a - Alpha color component value. + * @returns {boolean} + */ +ApiInlineLvlSdt.prototype.SetBackgroundColor = function(r, g, b, a){ return true; }; + +/** + * Returns the background color of the current content control. + * @memberof ApiInlineLvlSdt + * @since 8.3.2 + * @returns {null | {r:byte, g:byte, b:byte, a:byte}} + */ +ApiInlineLvlSdt.prototype.GetBackgroundColor = function(){ return null; }; + +/** + * Selects the current content control. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} + */ +ApiInlineLvlSdt.prototype.Select = function(){ return true; }; + +/** + * Sets the data binding for the current content control. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {XmlMapping | null} xmlMapping - The data binding to associate with the content control. + * @returns {boolean} + */ +ApiInlineLvlSdt.prototype.SetDataBinding = function(xmlMapping){ return true; }; + +/** + * Retrieves the data binding of the content control. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {XmlMapping} Returns the data binding of the content control if it exists, otherwise `null`. + */ +ApiInlineLvlSdt.prototype.GetDataBinding = function(){ return new XmlMapping(); }; + +/** + * Updates the content control using the value from the XML mapping. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the update was successful, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.UpdateFromXmlMapping = function(){ return true; }; + +/** + * Returns the content control data for the XML mapping. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {string} The string data representing the contents of the current content control. + */ +ApiInlineLvlSdt.prototype.GetDataForXmlMapping = function(){ return ""; }; + +/** + * Checks if the content control is a checkbox. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the content control is a checkbox, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.IsCheckBox = function(){ return true; }; + +/** + * Sets the checkbox value for the content control. + * This method updates the checkbox state of the content control to either checked or unchecked. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {boolean} isChecked - The state to set for the checkbox. `true` for checked, `false` for unchecked. + * @returns {boolean} Returns `true` if the checkbox value was successfully set, `false` if the content control is not a checkbox. + */ +ApiInlineLvlSdt.prototype.SetCheckBoxChecked = function(isChecked){ return true; }; + +/** + * Determines whether a checkbox content control is currently checked or unchecked. + * + * Throws: Error if the content control is not a checkbox. + * + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the checkbox is checked, `false` if the checkbox is unchecked. + */ +ApiInlineLvlSdt.prototype.IsCheckBoxChecked = function(){ return true; }; + +/** + * Checks whether the content control is a picture control. + * This method verifies if the content control is specifically a picture control. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the content control is a picture, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.IsPicture = function(){ return true; }; + +/** + * Sets the size for the picture in a content control. + * This method adjusts the width and height of the image if the content control is a picture. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {EMU} width - The desired image width . + * @param {EMU} height - The desired image height. + * @returns {boolean} Returns `true` if the size was successfully set, or `false` if the content control is not a picture. + */ +ApiInlineLvlSdt.prototype.SetPictureSize = function(width, height){ return true; }; + +/** + * Sets the content (image) for the picture content control. + * This method updates the picture inside a content control by setting an image from a provided URL. + * The URL should be an internet link to the image. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {string} imageUrl - The URL of the image to be used for the content control. + * Currently, only internet URLs are supported. + * @returns {boolean} Returns `true` if the image was successfully set, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.SetPicture = function(imageUrl){ return true; }; + +/** + * Checks whether the content control is a drop-down list. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the content control is a drop-down list, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.IsDropDownList = function(){ return true; }; + +/** + * Checks whether the content control is a combo box list. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the content control is a combo box list, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.IsComboBox = function(){ return true; }; + +/** + * Sets the selected item for a combo box list or drop-down list. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {string} name - The name of the item to be selected in the list. + * @returns {boolean} Returns `true` if the item was successfully selected, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.SelectListItem = function(name){ return true; }; + +/** + * Adds an item to a combo box list or drop-down list. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {string} name - The name of the item to add to the list. + * @param {string} value - The value of the item to add to the list. + * @param {number} [pos] - The optional position at which to insert the new item in the list. + * @returns {boolean} Returns `true` if the item was successfully added, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.AddListItem = function(name, value, pos){ return true; }; + +/** + * Removes an item from a combo box list or drop-down list. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {string} value - The value of the item to remove from the list. + * @returns {boolean} Returns `true` if the item was successfully removed, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.RemoveListItem = function(value){ return true; }; + +/** + * Checks whether the content control is a datepicker. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the content control is a datepicker, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.IsDatePicker = function(){ return true; }; + +/** + * Sets the value for the datepicker content control. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {Date} date - The date value to set for the datepicker. + * @returns {boolean} Returns `true` if the date was successfully set, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.SetDate = function(date){ return true; }; + +/** + * Retrieves the selected date value from a date picker content control and returns it as a Date object. + * + * Throws: Error if the content control is not a date picker. + * + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {Date} Date object representing the selected date in the date picker control. + */ +ApiInlineLvlSdt.prototype.GetDate = function(){ return new Date(); }; + +/** + * Sets the date format for the datepicker content control. + * This method allows setting the format in which the date should be displayed in the datepicker content control. + * The format string should be specified using common date format patterns (e.g., "mm.dd.yyyy"). + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {string} dateFormat - The desired date format (e.g., "mm.dd.yyyy"). + * @returns {boolean} Returns `true` if the date format was successfully set, otherwise `false`. + */ +ApiInlineLvlSdt.prototype.SetDateFormat = function(dateFormat){ return true; }; + +/** + * Sets the visualization type of the content control. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @param {"boundingBox"|"hidden"} type - The desired visualization type. + */ +ApiInlineLvlSdt.prototype.SetAppearance = function(type){}; + +/** + * Returns the visualization type of the content control. + * @memberof ApiInlineLvlSdt + * @since 9.0.0 + * @returns {"boundingBox"|"hidden"} type - The visualization type of the content control. + */ +ApiInlineLvlSdt.prototype.GetAppearance = function(){ return ""; }; + /** * Returns a type of the ApiContentControlList class. * @memberof ApiContentControlList - * @typeofeditors ["CDE"] * @returns {"contentControlList"} */ ApiContentControlList.prototype.GetClassType = function(){ return ""; }; /** - * Returns a collection of items (the ApiContentControlListEntry objects) of the combo box / dropdown list content control. + * Returns a collection of items (the ApiContentControlListEntry objects) of the combo box / drop-down list content control. * @memberof ApiContentControlList - * @typeofeditors ["CDE"] * @returns {ApiContentControlListEntry[]} */ ApiContentControlList.prototype.GetAllItems = function(){ return [new ApiContentControlListEntry()]; }; /** - * Returns a number of items of the combo box / dropdown list content control. + * Returns a number of items of the combo box / drop-down list content control. * @memberof ApiContentControlList - * @typeofeditors ["CDE"] * @returns {number} */ ApiContentControlList.prototype.GetElementsCount = function(){ return 0; }; /** - * Returns a parent of the combo box / dropdown list content control. + * Returns a parent of the combo box / drop-down list content control. * @memberof ApiContentControlList - * @typeofeditors ["CDE"] * @returns {ApiInlineLvlSdt | ApiBlockLvlSdt} */ ApiContentControlList.prototype.GetParent = function(){ return new ApiInlineLvlSdt(); }; /** - * Adds a new value to the combo box / dropdown list content control. + * Adds a new value to the combo box / drop-down list content control. * @memberof ApiContentControlList * @param {string} sText - The display text for the list item. - * @param {string} [sValue=sText] - The list item value. - * @param {number} [nIndex=this.GetElementsCount()] - A position where a new value will be added. - * @typeofeditors ["CDE"] + * @param {string} sValue - The list item value. By default is equal to sText parameter + * @param {number} [nIndex=-1] - A position where a new value will be added. If nIndex=-1 add to the end. * @returns {boolean} */ ApiContentControlList.prototype.Add = function(sText, sValue, nIndex){ return true; }; /** - * Clears a list of values of the combo box / dropdown list content control. + * Clears a list of values of the combo box / drop-down list content control. * @memberof ApiContentControlList - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiContentControlList.prototype.Clear = function(){}; +ApiContentControlList.prototype.Clear = function(){ return true; }; /** - * Returns an item of the combo box / dropdown list content control by the position specified in the request. + * Returns an item of the combo box / drop-down list content control by the position specified in the request. * @memberof ApiContentControlList * @param {number} nIndex - Item position. - * @typeofeditors ["CDE"] * @returns {ApiContentControlListEntry} */ ApiContentControlList.prototype.GetItem = function(nIndex){ return new ApiContentControlListEntry(); }; @@ -6923,97 +7751,85 @@ ApiContentControlList.prototype.GetItem = function(nIndex){ return new ApiConten /** * Returns a type of the ApiContentControlListEntry class. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {"contentControlList"} */ ApiContentControlListEntry.prototype.GetClassType = function(){ return ""; }; /** - * Returns a parent of the content control list item in the combo box / dropdown list content control. + * Returns a parent of the content control list item in the combo box / drop-down list content control. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {ApiContentControlList} */ ApiContentControlListEntry.prototype.GetParent = function(){ return new ApiContentControlList(); }; /** - * Selects the list entry in the combo box / dropdown list content control and sets the text of the content control to the selected item value. + * Selects the list entry in the combo box / drop-down list content control and sets the text of the content control to the selected item value. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiContentControlListEntry.prototype.Select = function(){ return true; }; /** - * Moves the current item in the parent combo box / dropdown list content control up one element. + * Moves the current item in the parent combo box / drop-down list content control up one element. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiContentControlListEntry.prototype.MoveUp = function(){ return true; }; /** - * Moves the current item in the parent combo box / dropdown list content control down one element, so that it is after the item that originally followed it. + * Moves the current item in the parent combo box / drop-down list content control down one element, so that it is after the item that originally followed it. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiContentControlListEntry.prototype.MoveDown = function(){ return true; }; /** - * Returns an index of the content control list item in the combo box / dropdown list content control. + * Returns an index of the content control list item in the combo box / drop-down list content control. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {number} */ ApiContentControlListEntry.prototype.GetIndex = function(){ return 0; }; /** - * Sets an index to the content control list item in the combo box / dropdown list content control. + * Sets an index to the content control list item in the combo box / drop-down list content control. * @memberof ApiContentControlListEntry * @param {number} nIndex - An index of the content control list item. - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiContentControlListEntry.prototype.SetIndex = function(nIndex){ return true; }; /** - * Deletes the specified item in the combo box / dropdown list content control. + * Deletes the specified item in the combo box / drop-down list content control. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {boolean} */ ApiContentControlListEntry.prototype.Delete = function(){ return true; }; /** - * Returns a String that represents the display text of a list item for the combo box / dropdown list content control. + * Returns a String that represents the display text of a list item for the combo box / drop-down list content control. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {string} */ ApiContentControlListEntry.prototype.GetText = function(){ return ""; }; /** - * Sets a String that represents the display text of a list item for the combo box / dropdown list content control. + * Sets a String that represents the display text of a list item for the combo box / drop-down list content control. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @param {string} sText - The display text of a list item. * @returns {boolean} */ ApiContentControlListEntry.prototype.SetText = function(sText){ return true; }; /** - * Returns a String that represents the value of a list item for the combo box / dropdown list content control. + * Returns a String that represents the value of a list item for the combo box / drop-down list content control. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @returns {string} */ ApiContentControlListEntry.prototype.GetValue = function(){ return ""; }; /** - * Sets a String that represents the value of a list item for the combo box / dropdown list content control. + * Sets a String that represents the value of a list item for the combo box / drop-down list content control. * @memberof ApiContentControlListEntry - * @typeofeditors ["CDE"] * @param {string} sValue - The value of a list item. * @returns {boolean} */ @@ -7022,26 +7838,50 @@ ApiContentControlListEntry.prototype.SetValue = function(sValue){ return true; } /** * Returns a type of the ApiBlockLvlSdt class. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {"blockLvlSdt"} */ ApiBlockLvlSdt.prototype.GetClassType = function(){ return ""; }; +/** + * Returns an internal id of the current content control. + * @memberof ApiBlockLvlSdt + * @returns {string} + */ +ApiBlockLvlSdt.prototype.GetInternalId = function(){ return ""; }; + +/** + * Specifies a unique ID for the current content control. + * @method + * @memberof ApiBlockLvlSdt + * @since 8.3.2 + * @param {number} id - The numerical ID which will be specified for the current content control. + */ +ApiBlockLvlSdt.prototype.SetId = ApiInlineLvlSdt.prototype.SetId;{}; + +/** + * Returns a unique ID for the current content control. + * @memberof ApiBlockLvlSdt + * @since 8.3.2 + * @returns {string} + */ +ApiBlockLvlSdt.prototype.GetId = function(){ return ""; }; + /** * Sets the lock to the current block text content control: + * "unlocked" - content can be edited and the container can be deleted. * "contentLocked" - content cannot be edited. * "sdtContentLocked" - content cannot be edited and the container cannot be deleted. * "sdtLocked" - the container cannot be deleted. + * @method * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {"contentLocked" | "sdtContentLocked" | "sdtLocked"} sLockType - The type of the lock applied to the block text content control. + * @param {"unlocked" | "contentLocked" | "sdtContentLocked" | "sdtLocked"} lockType - The type of the lock applied to the block text content control. + * @returns {boolean} */ -ApiBlockLvlSdt.prototype.SetLock = function(sLockType){}; +ApiBlockLvlSdt.prototype.SetLock = ApiInlineLvlSdt.prototype.SetLock;{ return true; }; /** * Returns the lock type of the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {SdtLock} */ ApiBlockLvlSdt.prototype.GetLock = function(){ return new SdtLock(); }; @@ -7049,15 +7889,14 @@ ApiBlockLvlSdt.prototype.GetLock = function(){ return new SdtLock(); }; /** * Sets the tag attribute to the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {string} sTag - The tag which will be added to the current container. + * @param {string} tag - The tag which will be added to the current container. + * @returns {boolean} */ -ApiBlockLvlSdt.prototype.SetTag = function(sTag){}; +ApiBlockLvlSdt.prototype.SetTag = function(tag){ return true; }; /** * Returns the tag attribute for the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiBlockLvlSdt.prototype.GetTag = function(){ return ""; }; @@ -7065,31 +7904,85 @@ ApiBlockLvlSdt.prototype.GetTag = function(){ return ""; }; /** * Sets the label attribute to the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {string} sLabel - The label which will be added to the current container. Can be a positive or negative integer from -2147483647 to 2147483647. + * @param {string} label - The label which will be added to the current container. Can be a positive or negative integer from -2147483647 to 2147483647. + * @returns {boolean} */ -ApiBlockLvlSdt.prototype.SetLabel = function(sLabel){}; +ApiBlockLvlSdt.prototype.SetLabel = function(label){ return true; }; /** * Returns the label attribute for the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiBlockLvlSdt.prototype.GetLabel = function(){ return ""; }; +/** + * Sets the data binding for the content control. + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @param {XmlMapping | null} xmlMapping - The data binding to associate with the content control. + * @returns {boolean} + */ +ApiBlockLvlSdt.prototype.SetDataBinding = function(xmlMapping){ return true; }; + +/** + * Sets the content (image) for the picture content control. + * This method updates the picture inside a content control by setting an image from a provided URL. + * The URL should be an internet link to the image. + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @param {string} imageUrl - The URL of the image to be used for the content control. + * Currently, only internet URLs are supported. + * @returns {boolean} Returns `true` if the image was successfully set, otherwise `false`. + */ +ApiBlockLvlSdt.prototype.SetPicture = function(imageUrl){ return true; }; + +/** + * Checks whether the content control is a picture control. + * This method verifies if the content control is specifically a picture control. + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the content control is a picture, otherwise `false`. + */ +ApiBlockLvlSdt.prototype.IsPicture = function(){ return true; }; + +/** + * Retrieves the data binding of the content control. + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @returns {XmlMapping} Returns the data binding of the content control if it exists, otherwise `null`. + */ +ApiBlockLvlSdt.prototype.GetDataBinding = function(){ return new XmlMapping(); }; + +/** + * Updates the content control using the value from the XML mapping. + * @method + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @returns {boolean} Returns `true` if the update was successful, otherwise `false`. + */ +ApiBlockLvlSdt.prototype.UpdateFromXmlMapping = ApiInlineLvlSdt.prototype.UpdateFromXmlMapping;{ return true; }; + +/** + * Returns the content control data for the XML mapping. + * @method + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @returns {string} The string data representing the contents of the current content control. + */ +ApiBlockLvlSdt.prototype.GetDataForXmlMapping = ApiInlineLvlSdt.prototype.GetDataForXmlMapping;{ return ""; }; + /** * Sets the alias attribute to the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {string} sAlias - The alias which will be added to the current container. + * @param {string} alias - The alias which will be added to the current container. + * @returns {boolean} */ -ApiBlockLvlSdt.prototype.SetAlias = function(sAlias){}; +ApiBlockLvlSdt.prototype.SetAlias = function(alias){ return true; }; /** * Returns the alias attribute for the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiBlockLvlSdt.prototype.GetAlias = function(){ return ""; }; @@ -7097,7 +7990,6 @@ ApiBlockLvlSdt.prototype.GetAlias = function(){ return ""; }; /** * Returns the content of the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiDocumentContent} */ ApiBlockLvlSdt.prototype.GetContent = function(){ return new ApiDocumentContent(); }; @@ -7105,7 +7997,6 @@ ApiBlockLvlSdt.prototype.GetContent = function(){ return new ApiDocumentContent( /** * Returns a collection of content control objects in the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt[] | ApiInlineLvlSdt[]} */ ApiBlockLvlSdt.prototype.GetAllContentControls = function(){ return [new ApiBlockLvlSdt()]; }; @@ -7113,7 +8004,6 @@ ApiBlockLvlSdt.prototype.GetAllContentControls = function(){ return [new ApiBloc /** * Returns a collection of paragraph objects in the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiParagraph[]} */ ApiBlockLvlSdt.prototype.GetAllParagraphs = function(){ return [new ApiParagraph()]; }; @@ -7123,16 +8013,14 @@ ApiBlockLvlSdt.prototype.GetAllParagraphs = function(){ return [new ApiParagraph * This method can be a little bit slow, because it runs the document calculation * process to arrange tables on the specified page. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param nPage - Page number. If it is not specified, an empty array will be returned. + * @param page - Page number. If it is not specified, an empty array will be returned. * @returns {ApiTable[]} */ -ApiBlockLvlSdt.prototype.GetAllTablesOnPage = function(nPage){ return [new ApiTable()]; }; +ApiBlockLvlSdt.prototype.GetAllTablesOnPage = function(page){ return [new ApiTable()]; }; /** * Clears the contents from the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {boolean} - returns true. */ ApiBlockLvlSdt.prototype.RemoveAllElements = function(){ return true; }; @@ -7140,7 +8028,6 @@ ApiBlockLvlSdt.prototype.RemoveAllElements = function(){ return true; }; /** * Removes a content control and its content. If keepContent is true, the content is not deleted. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @param {boolean} keepContent - Specifies if the content will be deleted or not. * @returns {boolean} - returns false if content control haven't parent. */ @@ -7149,23 +8036,21 @@ ApiBlockLvlSdt.prototype.Delete = function(keepContent){ return true; }; /** * Applies text settings to the content of the content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {ApiTextPr} oTextPr - The properties that will be set to the content of the content control. + * @param {ApiTextPr} textPr - The properties that will be set to the content of the content control. + * @returns {boolean} */ -ApiBlockLvlSdt.prototype.SetTextPr = function(oTextPr){}; +ApiBlockLvlSdt.prototype.SetTextPr = function(textPr){ return true; }; /** * Returns a collection of drawing objects in the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @returns {ApiDrawing[]} + * @returns {Drawing[]} */ -ApiBlockLvlSdt.prototype.GetAllDrawingObjects = function(){ return [new ApiDrawing()]; }; +ApiBlockLvlSdt.prototype.GetAllDrawingObjects = function(){ return [new Drawing()]; }; /** * Returns a content control that contains the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt | null} - returns null if parent content control doesn't exist. */ ApiBlockLvlSdt.prototype.GetParentContentControl = function(){ return new ApiBlockLvlSdt(); }; @@ -7173,7 +8058,6 @@ ApiBlockLvlSdt.prototype.GetParentContentControl = function(){ return new ApiBlo /** * Returns a table that contains the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiTable | null} - returns null is parent table does'n exist. */ ApiBlockLvlSdt.prototype.GetParentTable = function(){ return new ApiTable(); }; @@ -7181,7 +8065,6 @@ ApiBlockLvlSdt.prototype.GetParentTable = function(){ return new ApiTable(); }; /** * Returns a table cell that contains the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiTableCell | null} - returns null if parent cell doesn't exist. */ ApiBlockLvlSdt.prototype.GetParentTableCell = function(){ return new ApiTableCell(); }; @@ -7189,62 +8072,64 @@ ApiBlockLvlSdt.prototype.GetParentTableCell = function(){ return new ApiTableCel /** * Pushes a paragraph or a table or a block content control to actually add it to the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {DocumentElement} oElement - The type of the element which will be pushed to the current container. - * @returns {boolean} - returns false if oElement unsupported. + * @param {DocumentElement} element - The type of the element which will be pushed to the current container. + * @returns {boolean} - returns false if element unsupported. */ -ApiBlockLvlSdt.prototype.Push = function(oElement){ return true; }; +ApiBlockLvlSdt.prototype.Push = function(element){ return true; }; /** * Adds a paragraph or a table or a block content control to the current container. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {DocumentElement} oElement - The type of the element which will be added to the current container. - * @param {Number} nPos - The specified position. - * @returns {boolean} - returns false if oElement unsupported. + * @param {DocumentElement} element - The type of the element which will be added to the current container. + * @param {Number} pos - The specified position. + * @returns {boolean} - returns false if element unsupported. */ -ApiBlockLvlSdt.prototype.AddElement = function(oElement, nPos){ return true; }; +ApiBlockLvlSdt.prototype.AddElement = function(element, pos){ return true; }; /** * Adds a text to the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {String} sText - The text which will be added to the content control. + * @param {String} text - The text which will be added to the content control. * @returns {boolean} - returns false if param is invalid. */ -ApiBlockLvlSdt.prototype.AddText = function(sText){ return true; }; +ApiBlockLvlSdt.prototype.AddText = function(text){ return true; }; /** * Returns a Range object that represents the part of the document contained in the specified content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {Number} Start - Start character in the current element. - * @param {Number} End - End character in the current element. + * @param {Number} start - Start position index in the current element. + * @param {Number} end - End position index in the current element. * @returns {ApiRange} - * */ -ApiBlockLvlSdt.prototype.GetRange = function(Start, End){ return new ApiRange(); }; + */ +ApiBlockLvlSdt.prototype.GetRange = function(start, end){ return new ApiRange(); }; + +/** + * Creates a copy of a block content control. Ignores comments, footnote references, complex fields. + * @memberof ApiBlockLvlSdt + * @returns {ApiBlockLvlSdt} + * @since 8.3.0 + */ +ApiBlockLvlSdt.prototype.Copy = function(){ return new ApiBlockLvlSdt(); }; /** * Searches for a scope of a content control object. The search results are a collection of ApiRange objects. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {string} sText - Search string. + * @param {string} text - Search string. * @param {boolean} isMatchCase - Case sensitive or not. * @returns {ApiRange[]} */ -ApiBlockLvlSdt.prototype.Search = function(sText, isMatchCase){ return [new ApiRange()]; }; +ApiBlockLvlSdt.prototype.Search = function(text, isMatchCase){ return [new ApiRange()]; }; /** * Selects the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] + * @returns {boolean} */ -ApiBlockLvlSdt.prototype.Select = function(){}; +ApiBlockLvlSdt.prototype.Select = function(){ return true; }; /** * Returns the placeholder text from the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {string} */ ApiBlockLvlSdt.prototype.GetPlaceholderText = function(){ return ""; }; @@ -7252,16 +8137,14 @@ ApiBlockLvlSdt.prototype.GetPlaceholderText = function(){ return ""; }; /** * Sets the placeholder text to the current content control. * @memberof ApiBlockLvlSdt - * @param {string} sText - The text that will be set to the current content control. - * @typeofeditors ["CDE"] + * @param {string} text - The text that will be set to the current content control. * @returns {boolean} */ -ApiBlockLvlSdt.prototype.SetPlaceholderText = function(sText){ return true; }; +ApiBlockLvlSdt.prototype.SetPlaceholderText = function(text){ return true; }; /** * Returns the content control position within its parent element. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {Number} - returns -1 if the content control parent doesn't exist. */ ApiBlockLvlSdt.prototype.GetPosInParent = function(){ return 0; }; @@ -7269,7 +8152,6 @@ ApiBlockLvlSdt.prototype.GetPosInParent = function(){ return 0; }; /** * Replaces the current content control with a new element. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @param {DocumentElement} oElement - The element to replace the current content control with. * @returns {boolean} */ @@ -7279,52 +8161,119 @@ ApiBlockLvlSdt.prototype.ReplaceByElement = function(oElement){ return true; }; * Adds a comment to the current block content control. * Please note that the current block content control must be in the document. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {string} sText - The comment text (required). - * @param {string} sAuthor - The author's name (optional). - * @param {string} sUserId - The user ID of the comment author (optional). + * @param {string} text - The comment text. + * @param {string} [author] - The author's name. + * @param {string} [userId] - The user ID of the comment author. * @returns {ApiComment} - Returns null if the comment was not added. */ -ApiBlockLvlSdt.prototype.AddComment = function(sText, sAuthor, sUserId){ return new ApiComment(); }; +ApiBlockLvlSdt.prototype.AddComment = function(text, author, userId){ return new ApiComment(); }; /** * Adds a caption paragraph after (or before) the current content control. * Please note that the current content control must be in the document (not in the footer/header). * And if the current content control is placed in a shape, then a caption is added after (or before) the parent shape. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] - * @param {string} sAdditional - The additional text. - * @param {CaptionLabel | String} [sLabel="Table"] - The caption label. - * @param {boolean} [bExludeLabel=false] - Specifies whether to exclude the label from the caption. - * @param {CaptionNumberingFormat} [sNumberingFormat="Arabic"] - The possible caption numbering format. - * @param {boolean} [bBefore=false] - Specifies whether to insert the caption before the current content control (true) or after (false) (after/before the shape if it is placed in the shape). - * @param {Number} [nHeadingLvl=undefined] - The heading level (used if you want to specify the chapter number). + * @param {string} additionalText - The additional text. + * @param {CaptionLabel | String} [label="Table"] - The caption label. + * @param {boolean} [excludeLabel=false] - Specifies whether to exclude the label from the caption. + * @param {CaptionNumberingFormat} [numFormat="Arabic"] - The possible caption numbering format. + * @param {boolean} [isBefore=false] - Specifies whether to insert the caption before the current content control (true) or after (false) (after/before the shape if it is placed in the shape). + * @param {Number} [headingLvl=undefined] - The heading level (used if you want to specify the chapter number). * If you want to specify "Heading 1", then nHeadingLvl === 0 and etc. - * @param {CaptionSep} [sCaptionSep="hyphen"] - The caption separator (used if you want to specify the chapter number). + * @param {CaptionSep} [captionSep="hyphen"] - The caption separator (used if you want to specify the chapter number). * @returns {boolean} */ -ApiBlockLvlSdt.prototype.AddCaption = function(sAdditional, sLabel, bExludeLabel, sNumberingFormat, bBefore, nHeadingLvl, sCaptionSep){ return true; }; +ApiBlockLvlSdt.prototype.AddCaption = function(additionalText, label, excludeLabel, numFormat, isBefore, headingLvl, captionSep){ return true; }; /** - * Returns a list of values of the combo box / dropdown list content control. + * Returns a list of values of the combo box / drop-down list content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @returns {ApiContentControlList} */ ApiBlockLvlSdt.prototype.GetDropdownList = function(){ return new ApiContentControlList(); }; /** - * Place cursor before/after the current content control - * @param {boolean} [isAfter=true] + * Places a cursor before/after the current content control. + * @param {boolean} [isAfter=true] - Specifies whether a cursor will be placed before (false) or after (true) the current content control. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] + * @returns {boolean} + * @since 8.1.0 */ -ApiBlockLvlSdt.prototype.MoveCursorOutside = function(isAfter){}; +ApiBlockLvlSdt.prototype.MoveCursorOutside = function(isAfter){ return true; }; + +/** + * Creates a copy of an block content control. Ignores comments, footnote references, complex fields. + * @memberof ApiBlockLvlSdt + * @returns {ApiBlockLvlSdt} + */ +ApiBlockLvlSdt.prototype.Copy = function(){ return new ApiBlockLvlSdt(); }; + +/** + * Sets the border color to the current content control. + * @method + * @memberof ApiBlockLvlSdt + * @param {byte} r - Red color component value. + * @param {byte} g - Green color component value. + * @param {byte} b - Blue color component value. + * @param {byte} a - Alpha color component value. + * @since 8.3.2 + * @returns {boolean} + */ +ApiBlockLvlSdt.prototype.SetBorderColor = ApiInlineLvlSdt.prototype.SetBorderColor;{ return true; }; + +/** + * Returns the border color of the current content control. + * @method + * @memberof ApiBlockLvlSdt + * @since 8.3.2 + * @returns {null | {r:byte, g:byte, b:byte, a:byte}} + */ +ApiBlockLvlSdt.prototype.GetBorderColor = ApiInlineLvlSdt.prototype.GetBorderColor;{ return null; }; + +/** + * Sets the background color to the current content control. + * @memberof ApiBlockLvlSdt + * @method + * @param {byte} r - Red color component value. + * @param {byte} g - Green color component value. + * @param {byte} b - Blue color component value. + * @param {byte} a - Alpha color component value. + * @returns {boolean} + */ +ApiBlockLvlSdt.prototype.SetBackgroundColor = ApiInlineLvlSdt.prototype.SetBackgroundColor;{ return true; }; + +/** + * Returns the background color of the current content control. + * @memberof ApiBlockLvlSdt + * @method + * @since 8.3.2 + * @returns {null | {r:byte, g:byte, b:byte, a:byte}} + */ +ApiBlockLvlSdt.prototype.GetBackgroundColor = ApiInlineLvlSdt.prototype.GetBackgroundColor;{ return null; }; + +/** + * Sets the visualization of the content control. + * + * @method + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @param {"boundingBox"|"hidden"} type - The desired type of visualization. + */ +ApiBlockLvlSdt.prototype.SetAppearance = ApiInlineLvlSdt.prototype.SetAppearance;{}; + +/** + * Gets the visualization of the content control. + * + * @method + * @memberof ApiBlockLvlSdt + * @since 9.0.0 + * @returns {"boundingBox"|"hidden"} type - The type of visualization. + */ +ApiBlockLvlSdt.prototype.GetAppearance = ApiInlineLvlSdt.prototype.GetAppearance;{ return ""; }; /** * Returns a type of the ApiFormBase class. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {"form"} */ ApiFormBase.prototype.GetClassType = function(){ return ""; }; @@ -7332,7 +8281,6 @@ ApiFormBase.prototype.GetClassType = function(){ return ""; }; /** * Returns a type of the current form. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {FormType} */ ApiFormBase.prototype.GetFormType = function(){ return new FormType(); }; @@ -7340,7 +8288,6 @@ ApiFormBase.prototype.GetFormType = function(){ return new FormType(); }; /** * Returns the current form key. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {string} */ ApiFormBase.prototype.GetFormKey = function(){ return ""; }; @@ -7348,7 +8295,6 @@ ApiFormBase.prototype.GetFormKey = function(){ return ""; }; /** * Sets a key to the current form. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @param {string} sKey - Form key. * @returns {boolean} */ @@ -7357,7 +8303,6 @@ ApiFormBase.prototype.SetFormKey = function(sKey){ return true; }; /** * Returns the tip text of the current form. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {string} */ ApiFormBase.prototype.GetTipText = function(){ return ""; }; @@ -7365,7 +8310,6 @@ ApiFormBase.prototype.GetTipText = function(){ return ""; }; /** * Sets the tip text to the current form. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @param {string} sText - Tip text. * @returns {boolean} */ @@ -7374,7 +8318,6 @@ ApiFormBase.prototype.SetTipText = function(sText){ return true; }; /** * Checks if the current form is required. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiFormBase.prototype.IsRequired = function(){ return true; }; @@ -7382,7 +8325,6 @@ ApiFormBase.prototype.IsRequired = function(){ return true; }; /** * Specifies if the current form should be required. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @param {boolean} bRequired - Defines if the current form is required (true) or not (false). * @returns {boolean} */ @@ -7391,7 +8333,6 @@ ApiFormBase.prototype.SetRequired = function(bRequired){ return true; }; /** * Checks if the current form is fixed size. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiFormBase.prototype.IsFixed = function(){ return true; }; @@ -7399,18 +8340,17 @@ ApiFormBase.prototype.IsFixed = function(){ return true; }; /** * Converts the current form to a fixed size form. * @memberof ApiFormBase - * @param {twips} nWidth - The wrapper shape width measured in twentieths of a point (1/1440 of an inch). - * @param {twips} nHeight - The wrapper shape height measured in twentieths of a point (1/1440 of an inch). - * @typeofeditors ["CDE", "CFE"] + * @param {twips} width - The wrapper shape width measured in twentieths of a point (1/1440 of an inch). + * @param {twips} height - The wrapper shape height measured in twentieths of a point (1/1440 of an inch). + * @param {boolean} keepPosition - Save position on the page (it can be a little bit slow, because it runs the document calculation). * @returns {boolean} */ -ApiFormBase.prototype.ToFixed = function(nWidth, nHeight){ return true; }; +ApiFormBase.prototype.ToFixed = function(width, height, keepPosition){ return true; }; /** * Converts the current form to an inline form. - * *Picture form can't be converted to an inline form, it's always a fixed size object.* + *Picture form can't be converted to an inline form, it's always a fixed size object.* * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiFormBase.prototype.ToInline = function(){ return true; }; @@ -7422,7 +8362,6 @@ ApiFormBase.prototype.ToInline = function(){ return true; }; * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} bNone - Defines that border color will not be set. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiFormBase.prototype.SetBorderColor = function(r, g, b, bNone){ return true; }; @@ -7434,16 +8373,13 @@ ApiFormBase.prototype.SetBorderColor = function(r, g, b, bNone){ return true; }; * @param {byte} g - Green color component value. * @param {byte} b - Blue color component value. * @param {boolean} bNone - Defines that background color will not be set. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiFormBase.prototype.SetBackgroundColor = function(r, g, b, bNone){ return true; }; /** * Returns the text from the current form. - * *Returns the value as a string if possible for the given form type* * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {string} */ ApiFormBase.prototype.GetText = function(){ return ""; }; @@ -7451,68 +8387,97 @@ ApiFormBase.prototype.GetText = function(){ return ""; }; /** * Clears the current form. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] + * @returns {boolean} */ -ApiFormBase.prototype.Clear = function(){}; +ApiFormBase.prototype.Clear = function(){ return true; }; /** * Returns a shape in which the form is placed to control the position and size of the fixed size form frame. * The null value will be returned for the inline forms. * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {ApiShape} - returns the shape in which the form is placed. */ ApiFormBase.prototype.GetWrapperShape = function(){ return new ApiShape(); }; /** * Sets the placeholder text to the current form. - * *Can't be set to checkbox or radio button.* + *Can't be set to checkbox or radio button.* * @memberof ApiFormBase * @param {string} sText - The text that will be set to the current form. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiFormBase.prototype.SetPlaceholderText = function(sText){ return true; }; /** * Sets the text properties to the current form. - * *Used if possible for this type of form* + *Used if possible for this type of form* * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] - * @param {ApiTextPr} oTextPr - The text properties that will be set to the current form. + * @param {ApiTextPr} textPr - The text properties that will be set to the current form. * @returns {boolean} */ -ApiFormBase.prototype.SetTextPr = function(oTextPr){ return true; }; +ApiFormBase.prototype.SetTextPr = function(textPr){ return true; }; /** * Returns the text properties from the current form. - * *Used if possible for this type of form* + *Used if possible for this type of form* * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {ApiTextPr} */ ApiFormBase.prototype.GetTextPr = function(){ return new ApiTextPr(); }; /** - * Place cursor before/after the current form. - * @param {boolean} [isAfter=true] + * Places a cursor before/after the current form. + * @param {boolean} [isAfter=true] - Specifies whether a cursor will be placed before (false) or after (true) the current form. * @memberof ApiFormBase - * @typeofeditors ["CDE"] + * @returns {boolean} + * @since 8.1.0 */ -ApiFormBase.prototype.MoveCursorOutside = function(isAfter){}; +ApiFormBase.prototype.MoveCursorOutside = function(isAfter){ return true; }; /** * Copies the current form (copies with the shape if it exists). * @memberof ApiFormBase - * @typeofeditors ["CDE", "CFE"] * @returns {ApiForm} */ ApiFormBase.prototype.Copy = function(){ return new ApiForm(); }; +/** + * Returns the tag attribute for the current form. + * @memberof ApiFormBase + * @since 9.0.0 + * @returns {string} + */ +ApiFormBase.prototype.GetTag = function(){ return ""; }; + +/** + * Sets the tag attribute to the current form. + * @memberof ApiFormBase + * @since 9.0.0 + * @param {string} tag - The tag which will be added to the current container. + * @returns {boolean} + */ +ApiFormBase.prototype.SetTag = function(tag){ return true; }; + +/** + * Returns the role of the current form. + * @memberof ApiFormBase + * @since 9.0.0 + * @returns {string} + */ +ApiFormBase.prototype.GetRole = function(){ return ""; }; + +/** + * Sets the role to the current form. + * @memberof ApiFormBase + * @since 9.0.0 + * @param {string} role - The role which will be attached to the current form. + * @returns {boolean} + */ +ApiFormBase.prototype.SetRole = function(role){ return true; }; + /** * Checks if the text field content is autofit, i.e. whether the font size adjusts to the size of the fixed size form. * @memberof ApiTextForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.IsAutoFit = function(){ return true; }; @@ -7521,7 +8486,6 @@ ApiTextForm.prototype.IsAutoFit = function(){ return true; }; * Specifies if the text field content should be autofit, i.e. whether the font size adjusts to the size of the fixed size form. * @memberof ApiTextForm * @param {boolean} bAutoFit - Defines if the text field content is autofit (true) or not (false). - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.SetAutoFit = function(bAutoFit){ return true; }; @@ -7529,7 +8493,6 @@ ApiTextForm.prototype.SetAutoFit = function(bAutoFit){ return true; }; /** * Checks if the current text field is multiline. * @memberof ApiTextForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.IsMultiline = function(){ return true; }; @@ -7538,7 +8501,6 @@ ApiTextForm.prototype.IsMultiline = function(){ return true; }; * Specifies if the current text field should be miltiline. * @memberof ApiTextForm * @param {boolean} bMultiline - Defines if the current text field is multiline (true) or not (false). - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} - return false, if the text field is not fixed size. */ ApiTextForm.prototype.SetMultiline = function(bMultiline){ return true; }; @@ -7546,7 +8508,6 @@ ApiTextForm.prototype.SetMultiline = function(bMultiline){ return true; }; /** * Returns a limit of the text field characters. * @memberof ApiTextForm - * @typeofeditors ["CDE", "CFE"] * @returns {number} - if this method returns -1 -> the form has no limit for characters */ ApiTextForm.prototype.GetCharactersLimit = function(){ return 0; }; @@ -7557,7 +8518,6 @@ ApiTextForm.prototype.GetCharactersLimit = function(){ return 0; }; * @param {number} nChars - The maximum number of characters in the text field. If this parameter is equal to -1, no limit will be set. * A limit is required to be set if a comb of characters is applied. * Maximum value for this parameter is 1000000. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.SetCharactersLimit = function(nChars){ return true; }; @@ -7565,7 +8525,6 @@ ApiTextForm.prototype.SetCharactersLimit = function(nChars){ return true; }; /** * Checks if the text field is a comb of characters with the same cell width. * @memberof ApiTextForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.IsComb = function(){ return true; }; @@ -7575,7 +8534,6 @@ ApiTextForm.prototype.IsComb = function(){ return true; }; * The maximum number of characters must be set to a positive value. * @memberof ApiTextForm * @param {boolean} bComb - Defines if the text field is a comb of characters (true) or not (false). - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.SetComb = function(bComb){ return true; }; @@ -7585,7 +8543,6 @@ ApiTextForm.prototype.SetComb = function(bComb){ return true; }; * @memberof ApiTextForm * @param {mm} [nCellWidth=0] - The cell width measured in millimeters. * If this parameter is not specified or equal to 0 or less, then the width will be set automatically. Must be >= 1 and <= 558.8. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.SetCellWidth = function(nCellWidth){ return true; }; @@ -7594,7 +8551,6 @@ ApiTextForm.prototype.SetCellWidth = function(nCellWidth){ return true; }; * Sets the text to the current text field. * @memberof ApiTextForm * @param {string} sText - The text that will be set to the current text field. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiTextForm.prototype.SetText = function(sText){ return true; }; @@ -7602,7 +8558,6 @@ ApiTextForm.prototype.SetText = function(sText){ return true; }; /** * Returns the current scaling condition of the picture form. * @memberof ApiPictureForm - * @typeofeditors ["CDE", "CFE"] * @returns {ScaleFlag} */ ApiPictureForm.prototype.GetScaleFlag = function(){ return new ScaleFlag(); }; @@ -7611,7 +8566,6 @@ ApiPictureForm.prototype.GetScaleFlag = function(){ return new ScaleFlag(); }; * Sets the scaling condition to the current picture form. * @memberof ApiPictureForm * @param {ScaleFlag} sScaleFlag - Picture scaling condition: "always", "never", "tooBig" or "tooSmall". - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiPictureForm.prototype.SetScaleFlag = function(sScaleFlag){ return true; }; @@ -7620,7 +8574,6 @@ ApiPictureForm.prototype.SetScaleFlag = function(sScaleFlag){ return true; }; * Locks the aspect ratio of the current picture form. * @memberof ApiPictureForm * @param {boolean} [isLock=true] - Specifies if the aspect ratio of the current picture form will be locked (true) or not (false). - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiPictureForm.prototype.SetLockAspectRatio = function(isLock){ return true; }; @@ -7628,20 +8581,18 @@ ApiPictureForm.prototype.SetLockAspectRatio = function(isLock){ return true; }; /** * Checks if the aspect ratio of the current picture form is locked or not. * @memberof ApiPictureForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiPictureForm.prototype.IsLockAspectRatio = function(){ return true; }; /** * Sets the picture position inside the current form: - * * 0 - the picture is placed on the left/top; - * * 50 - the picture is placed in the center; - * * 100 - the picture is placed on the right/bottom. + * 0 - the picture is placed on the left/top; + * 50 - the picture is placed in the center; + * 100 - the picture is placed on the right/bottom. * @memberof ApiPictureForm * @param {percentage} nShiftX - Horizontal position measured in percent. * @param {percentage} nShiftY - Vertical position measured in percent. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiPictureForm.prototype.SetPicturePosition = function(nShiftX, nShiftY){ return true; }; @@ -7649,7 +8600,6 @@ ApiPictureForm.prototype.SetPicturePosition = function(nShiftX, nShiftY){ return /** * Returns the picture position inside the current form. * @memberof ApiPictureForm - * @typeofeditors ["CDE", "CFE"] * @returns {Array.} Array of two numbers [shiftX, shiftY] */ ApiPictureForm.prototype.GetPicturePosition = function(){ return []; }; @@ -7658,7 +8608,6 @@ ApiPictureForm.prototype.GetPicturePosition = function(){ return []; }; * Respects the form border width when scaling the image. * @memberof ApiPictureForm * @param {boolean} [isRespect=true] - Specifies if the form border width will be respected (true) or not (false). - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiPictureForm.prototype.SetRespectBorders = function(isRespect){ return true; }; @@ -7666,7 +8615,6 @@ ApiPictureForm.prototype.SetRespectBorders = function(isRespect){ return true; } /** * Checks if the form border width is respected or not. * @memberof ApiPictureForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiPictureForm.prototype.IsRespectBorders = function(){ return true; }; @@ -7674,8 +8622,7 @@ ApiPictureForm.prototype.IsRespectBorders = function(){ return true; }; /** * Returns an image in the base64 format from the current picture form. * @memberof ApiPictureForm - * @typeofeditors ["CDE", "CFE"] - * @returns {base64img} + * @returns {Base64Img} */ ApiPictureForm.prototype.GetImage = function(){ return base64img; }; @@ -7685,7 +8632,6 @@ ApiPictureForm.prototype.GetImage = function(){ return base64img; }; * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or base64 encoded images are supported). * @param {EMU} nWidth - The image width in English measure units. * @param {EMU} nHeight - The image height in English measure units. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiPictureForm.prototype.SetImage = function(sImageSrc, nWidth, nHeight){ return true; }; @@ -7693,7 +8639,6 @@ ApiPictureForm.prototype.SetImage = function(sImageSrc, nWidth, nHeight){ return /** * Returns the list values from the current combo box. * @memberof ApiComboBoxForm - * @typeofeditors ["CDE", "CFE"] * @returns {string[]} */ ApiComboBoxForm.prototype.GetListValues = function(){ return [""]; }; @@ -7702,7 +8647,6 @@ ApiComboBoxForm.prototype.GetListValues = function(){ return [""]; }; * Sets the list values to the current combo box. * @memberof ApiComboBoxForm * @param {string[]} aListString - The combo box list values. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiComboBoxForm.prototype.SetListValues = function(aListString){ return true; }; @@ -7711,25 +8655,22 @@ ApiComboBoxForm.prototype.SetListValues = function(aListString){ return true; }; * Selects the specified value from the combo box list values. * @memberof ApiComboBoxForm * @param {string} sValue - The combo box list value that will be selected. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiComboBoxForm.prototype.SelectListValue = function(sValue){ return true; }; /** * Sets the text to the current combo box. - * *Available only for editable combo box forms.* + *Available only for editable combo box forms.* * @memberof ApiComboBoxForm * @param {string} sText - The combo box text. - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiComboBoxForm.prototype.SetText = function(sText){ return true; }; /** - * Checks if the combo box text can be edited. If it is not editable, then this form is a dropdown list. + * Checks if the combo box text can be edited. If it is not editable, then this form is a drop-down list. * @memberof ApiComboBoxForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiComboBoxForm.prototype.IsEditable = function(){ return true; }; @@ -7738,7 +8679,6 @@ ApiComboBoxForm.prototype.IsEditable = function(){ return true; }; * Checks the current checkbox. * @memberof ApiCheckBoxForm * @param {boolean} isChecked - Specifies if the current checkbox will be checked (true) or not (false). - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiCheckBoxForm.prototype.SetChecked = function(isChecked){ return true; }; @@ -7746,7 +8686,6 @@ ApiCheckBoxForm.prototype.SetChecked = function(isChecked){ return true; }; /** * Returns the state of the current checkbox (checked or not). * @memberof ApiCheckBoxForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiCheckBoxForm.prototype.IsChecked = function(){ return true; }; @@ -7754,7 +8693,6 @@ ApiCheckBoxForm.prototype.IsChecked = function(){ return true; }; /** * Checks if the current checkbox is a radio button. * @memberof ApiCheckBoxForm - * @typeofeditors ["CDE", "CFE"] * @returns {boolean} */ ApiCheckBoxForm.prototype.IsRadioButton = function(){ return true; }; @@ -7762,7 +8700,6 @@ ApiCheckBoxForm.prototype.IsRadioButton = function(){ return true; }; /** * Returns the radio group key if the current checkbox is a radio button. * @memberof ApiCheckBoxForm - * @typeofeditors ["CDE", "CFE"] * @returns {string} */ ApiCheckBoxForm.prototype.GetRadioGroup = function(){ return ""; }; @@ -7771,14 +8708,30 @@ ApiCheckBoxForm.prototype.GetRadioGroup = function(){ return ""; }; * Sets the radio group key to the current radio button. * @memberof ApiCheckBoxForm * @param {string} sKey - Radio group key. - * @typeofeditors ["CDE", "CFE"] + * @returns {boolean} */ -ApiCheckBoxForm.prototype.SetRadioGroup = function(sKey){}; +ApiCheckBoxForm.prototype.SetRadioGroup = function(sKey){ return true; }; + +/** + * Returns the choice name of the current radio button. + * @memberof ApiCheckBoxForm + * @since 8.3.2 + * @returns {string} + * */ +ApiCheckBoxForm.prototype.GetChoiceName = function(){ return ""; }; + +/** + * Sets the choice name for the current radio button. + * @memberof ApiCheckBoxForm + * @param {string} choiceName - The radio button choice name. + * @since 8.3.2 + * @returns {boolean} + * */ +ApiCheckBoxForm.prototype.SetChoiceName = function(choiceName){ return true; }; /** * Gets the date format of the current form. * @memberof ApiDateForm - * @typeofeditors ["CDE", "CFE"] * @returns {string} * @since 8.1.0 */ @@ -7787,7 +8740,6 @@ ApiDateForm.prototype.GetFormat = function() { return ""; }; /** * Sets the date format to the current form. * @memberof ApiDateForm - * @typeofeditors ["CDE", "CFE"] * @param {string} sFormat - The date format. For example, mm.dd.yyyy * @returns {boolean} * @since 8.1.0 @@ -7797,7 +8749,6 @@ ApiDateForm.prototype.SetFormat = function(sFormat){ return true; }; /** * Gets the used date language of the current form. * @memberof ApiDateForm - * @typeofeditors ["CDE", "CFE"] * @returns {string} * @since 8.1.0 */ @@ -7806,7 +8757,6 @@ ApiDateForm.prototype.GetLanguage = function() { return ""; }; /** * Sets the date language to the current form. * @memberof ApiDateForm - * @typeofeditors ["CDE", "CFE"] * @param {string} sLangId - The date language. The possible value for this parameter is a language identifier as defined in * RFC 4646/BCP 47. Example: "en-CA". * @returns {boolean} @@ -7817,7 +8767,6 @@ ApiDateForm.prototype.SetLanguage = function(sLangId){ return true; }; /** * Returns the timestamp of the current form. * @memberof ApiDateForm - * @typeofeditors ["CDE", "CFE"] * @returns {number} * @since 8.1.0 */ @@ -7826,17 +8775,57 @@ ApiDateForm.prototype.GetTime = function(){ return 0; }; /** * Sets the timestamp to the current form. * @memberof ApiDateForm - * @typeofeditors ["CDE", "CFE"] * @param {number} nTimeStamp The timestamp that will be set to the current date form. * @returns {boolean} * @since 8.1.0 */ ApiDateForm.prototype.SetTime = function(nTimeStamp){ return true; }; +/** + * Sets the date to the current form. + * @memberof ApiDateForm + * @param {Date | string} date - The date object or the date in the string format. + * @returns {boolean} + * @since 9.0.0 + */ +ApiDateForm.prototype.SetDate = function(date){ return true; }; + +/** + * Returns the date of the current form. + * @memberof ApiDateForm + * @returns {Date} - The date object. + * @since 9.0.0 + */ +ApiDateForm.prototype.GetDate = function(){ return new Date(); }; + +/** + * Appends the text content of the given form to the end of the current complex form. + * @memberof ApiComplexForm + * @param value {string | ApiDateForm | ApiPictureForm | ApiCheckBoxForm | ApiComboBoxForm | ApiTextForm} - The text or the form to add. + * @returns {boolean} + * @since 9.0.0 + */ +ApiComplexForm.prototype.Add = function(value){ return true; }; + +/** + * Returns an ordered list of subforms. + * @memberof ApiComplexForm + * @returns {ApiForm[]} + * @since 9.0.0 + */ +ApiComplexForm.prototype.GetSubForms = function(){ return [new ApiForm()]; }; + +/** + * Clears all content from the current complex form, resetting it to its placeholder state. + * @memberof ApiComplexForm + * @returns {boolean} + * @since 9.0.0 + */ +ApiComplexForm.prototype.ClearContent = function(){ return true; }; + /** * Converts the ApiBlockLvlSdt object into the JSON object. * @memberof ApiBlockLvlSdt - * @typeofeditors ["CDE"] * @param {boolean} bWriteNumberings - Specifies if the used numberings will be written to the JSON object or not. * @param {boolean} bWriteStyles - Specifies if the used styles will be written to the JSON object or not. * @returns {JSON} @@ -7846,63 +8835,58 @@ ApiBlockLvlSdt.prototype.ToJSON = function(bWriteNumberings, bWriteStyles){ retu /** * Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings. * @memberof ApiInterface - * @typeofeditors ["CDE", "CSE", "CPE"] - * @param {Array} arrString - An array of replacement strings. - * @param {string} [sParaTab=" "] - A character which is used to specify the tab in the source text. - * @param {string} [sParaNewLine=" "] - A character which is used to specify the line break character in the source text. + * @param {string[]} textStrings - An array of replacement strings. + * @param {string} [tab="\t"] - A character which is used to specify the tab in the source text. + * @param {string} [newLine="\r\n"] - A character which is used to specify the line break character in the source text. + * @returns {boolean} */ -ApiInterface.prototype.ReplaceTextSmart = function(arrString, sParaTab, sParaNewLine){}; +ApiInterface.prototype.ReplaceTextSmart = function(textStrings, tab, newLine){ return true; }; /** * Converts a document to Markdown or HTML text. * @memberof ApiInterface - * @typeofeditors ["CDE"] - * @param {"markdown" | "html"} [sConvertType="markdown"] - Conversion type. - * @param {boolean} [bHtmlHeadings=false] - Defines if the HTML headings and IDs will be generated when the Markdown renderer of your target platform does not handle Markdown-style IDs. - * @param {boolean} [bBase64img=false] - Defines if the images will be created in the base64 format. - * @param {boolean} [bDemoteHeadings=false] - Defines if all heading levels in your document will be demoted to conform with the following standard: single H1 as title, H2 as top-level heading in the text body. - * @param {boolean} [bRenderHTMLTags=false] - Defines if HTML tags will be preserved in your Markdown. If you just want to use an occasional HTML tag, you can avoid using the opening angle bracket + * @param {"markdown" | "html"} [convertType="markdown"] - Conversion type. + * @param {boolean} [htmlHeadings=false] - Defines if the HTML headings and IDs will be generated when the Markdown renderer of your target platform does not handle Markdown-style IDs. + * @param {boolean} [base64img=false] - Defines if the images will be created in the base64 format. + * @param {boolean} [demoteHeadings=false] - Defines if all heading levels in your document will be demoted to conform with the following standard: single H1 as title, H2 as top-level heading in the text body. + * @param {boolean} [renderHTMLTags=false] - Defines if HTML tags will be preserved in your Markdown. If you just want to use an occasional HTML tag, you can avoid using the opening angle bracket * in the following way: \>} items - The combo box items. +В  В  В * This array consists of strings or arrays of two strings where the first string is the displayed value and the second one is its meaning. +В  В  В * If the array consists of single strings, then the displayed value and its meaning are the same. +В  В  В * Example: ["First", ["Second", "2"], ["Third", "3"], "Fourth"]. + + */ + +/** + * Combo box / dropdown list properties. + * @typedef {FormPrBase | ComboBoxFormPrBase} ComboBoxFormPr + */ + +/** + * The condition to scale an image in the picture form. + * @typedef {"always" | "never" | "tooBig" | "tooSmall"} ScaleFlag + */ + +/** + * Value from 0 to 100. + * @typedef {number} percentage + */ + +/** + * Specific picture form properties. + * @typedef {Object} PictureFormPrBase + * @property {ScaleFlag} scaleFlag - The condition to scale an image in the picture form: "always", "never", "tooBig" or "tooSmall". + * @property {boolean} lockAspectRatio - Specifies if the aspect ratio of the picture form is locked or not. + * @property {boolean} respectBorders - Specifies if the form border width is respected or not when scaling the image. + * @property {percentage} shiftX - Horizontal picture position inside the picture form measured in percent: + * 0 - the picture is placed on the left; + * 50 - the picture is placed in the center; + * 100 - the picture is placed on the right. + * @property {percentage} shiftY - Vertical picture position inside the picture form measured in percent: + * 0 - the picture is placed on top; + * 50 - the picture is placed in the center; + * 100 - the picture is placed on the bottom. + */ + +/** + * Picture form properties. + * @typedef {FormPrBase | PictureFormPrBase} PictureFormPr + */ + +/** + * Specific date form properties. + * @typedef {Object} DateFormPrBase + * @property {string} format- The date format, ex: mm.dd.yyyy + * @property {string} lang- The date language. Possible value for this parameter is a language identifier as defined by + * RFC 4646/BCP 47. Example: "en-CA". + */ + +/** + * Date form properties. + * @typedef {FormPrBase | DateFormPrBase} DateFormPr + */ + +/** + * Creates a text field with the specified text field properties. + * @memberof ApiInterface + * @param {TextFormPr} oFormPr - Text field properties. + * @returns {ApiTextForm} + */ +ApiInterface.prototype.CreateTextForm = function(oFormPr){ return new ApiTextForm(); }; + +/** + * Creates a checkbox / radio button with the specified checkbox / radio button properties. + * @memberof ApiInterface + * @param {CheckBoxFormPr} oFormPr - Checkbox / radio button properties. + * @returns {ApiCheckBoxForm} + */ +ApiInterface.prototype.CreateCheckBoxForm = function(oFormPr){ return new ApiCheckBoxForm(); }; + +/** + * Creates a combo box / dropdown list with the specified combo box / dropdown list properties. + * @memberof ApiInterface + * @param {ComboBoxFormPr} oFormPr - Combo box / dropdown list properties. + * @returns {ApiComboBoxForm} + */ +ApiInterface.prototype.CreateComboBoxForm = function(oFormPr){ return new ApiComboBoxForm(); }; + +/** + * Creates a picture form with the specified picture form properties. + * @memberof ApiInterface + * @param {PictureFormPr} oFormPr - Picture form properties. + * @returns {ApiPictureForm} + */ +ApiInterface.prototype.CreatePictureForm = function(oFormPr){ return new ApiPictureForm(); }; + +/** + * Creates a date form with the specified date form properties. + * @memberof ApiInterface + * @param {DateFormPr} oFormPr - Date form properties. + * @returns {ApiDateForm} + */ +ApiInterface.prototype.CreateDateForm = function(oFormPr){ return new ApiDateForm(); };