Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Api documentation #2913

Merged
merged 3 commits into from
Aug 2, 2022
Merged

Api documentation #2913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1550015
small fixes for word api documentation
ovchinnikova-natalya Aug 2, 2022
6668ea0
small fixes for the cell api documentation
ovchinnikova-natalya Aug 2, 2022
d35008a
small fixes for the slide and word api documentation
ovchinnikova-natalya Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions cell/apiBuilder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
ApiChart.prototype.constructor = ApiChart;

/**
* Class representing an Ole-object.
* Class representing an OLE object.
* @constructor
*/
function ApiOleObject(OleObject)
Expand Down Expand Up @@ -228,7 +228,7 @@
* | "textCurveDown" | "textCurveUp" | "textDeflate" | "textDeflateBottom" | "textDeflateInflate" | "textDeflateInflateDeflate" | "textDeflateTop"
* | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop"
* | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted"
* | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransofrm
* | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform
* */

/**
Expand Down Expand Up @@ -1465,12 +1465,12 @@
* @typeofeditors ["CSE"]
* @param {ApiTextPr} [oTextPr=Api.CreateTextPr()] - The text properties.
* @param {string} [sText="Your text here"] - The text for the Text Art object.
* @param {TextTransofrm} [sTransform="textNoShape"] - Text transform type.
* @param {TextTransform} [sTransform="textNoShape"] - Text transform type.
* @param {ApiFill} [oFill=Api.CreateNoFill()] - The color or pattern used to fill the Text Art object.
* @param {ApiStroke} [oStroke=Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the Text Art object shadow.
* @param {number} [nRotAngle=0] - Rotation angle.
* @param {EMU} [nWidth=1828800] - Text Art width measured in English measure units.
* @param {EMU} [nHeight=1828800] - Text Art heigth measured in English measure units.
* @param {EMU} [nWidth=1828800] - The Text Art width measured in English measure units.
* @param {EMU} [nHeight=1828800] - The Text Art heigth measured in English measure units.
* @param {number} [nFromCol=0] - The column number where the beginning of the Text Art object will be placed.
* @param {number} [nFromRow=0] - The row number where the beginning of the Text Art object will be placed.
* @param {EMU} [nColOffset=0] - The offset from the nFromCol column to the left part of the Text Art object measured in English measure units.
Expand Down Expand Up @@ -1498,18 +1498,18 @@
};

/**
* Adds an Ole-object with the parameters specified.
* 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.
* @param {string} sData - ole-object string data.
* @param {string} sAppId - the application id associated with this object.
* @param {number} nFromCol - The number of the column where the beginning of the Ole-object will be placed.
* @param {EMU} nColOffset - The offset from the nFromCol column to the left part of the Ole-object measured in English measure units.
* @param {number} nFromRow - The number of the row where the beginning of the Ole-object will be placed.
* @param {EMU} nRowOffset - The offset from the nFromRow row to the upper part of the Ole-object measured in English measure units.
* @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 {number} nFromCol - The number of the column where the beginning of the OLE object will be placed.
* @param {EMU} nColOffset - The offset from the nFromCol column to the left part of the OLE object measured in English measure units.
* @param {number} nFromRow - The number of the row where the beginning of the OLE object will be placed.
* @param {EMU} nRowOffset - The offset from the nFromRow row to the upper part of the OLE object measured in English measure units.
* @returns {ApiOleObject}
*/
ApiWorksheet.prototype.AddOleObject = function(sImageSrc, nWidth, nHeight, sData, sAppId, nFromCol, nColOffset, nFromRow, nRowOffset)
Expand Down Expand Up @@ -1692,7 +1692,7 @@
};

/**
* Returns all ole-objects from the current sheet.
* Returns all OLE objects from the current sheet.
* @memberof ApiWorksheet
* @typeofeditors ["CSE"]
* @returns {ApiOleObject[]}.
Expand Down Expand Up @@ -3931,10 +3931,10 @@
};

/**
* Sets the data to current Ole-object.
* Sets the data to the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @param {string} sData - ole-object string data.
* @param {string} sData - The OLE object string data.
* @returns {boolean}
*/
ApiOleObject.prototype.SetData = function(sData)
Expand All @@ -3947,7 +3947,7 @@
};

/**
* Gets the string data from current Ole-object.
* Returns the string data from the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @returns {string}
Expand All @@ -3961,10 +3961,10 @@
};

/**
* Sets the application id to current Ole-object.
* Sets the application ID to the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @param {string} sAppId - the application id associated with this object.
* @param {string} sAppId - The application ID associated with the current OLE object.
* @returns {boolean}
*/
ApiOleObject.prototype.SetApplicationId = function(sAppId)
Expand All @@ -3977,7 +3977,7 @@
};

/**
* Gets the application id from current Ole-object.
* Returns the application ID from the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @returns {string}
Expand Down
44 changes: 22 additions & 22 deletions slide/apiBuilder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
ApiGroup.prototype.constructor = ApiGroup;

/**
* Class representing an Ole-object.
* Class representing an OLE object.
* @constructor
*/
function ApiOleObject(OleObject)
Expand Down Expand Up @@ -323,18 +323,18 @@
* */

/**
* Text transform preset
* Text transform type.
* @typedef {("textArchDown" | "textArchDownPour" | "textArchUp" | "textArchUpPour" | "textButton" | "textButtonPour" | "textCanDown"
* | "textCanUp" | "textCascadeDown" | "textCascadeUp" | "textChevron" | "textChevronInverted" | "textCircle" | "textCirclePour"
* | "textCurveDown" | "textCurveUp" | "textDeflate" | "textDeflateBottom" | "textDeflateInflate" | "textDeflateInflateDeflate" | "textDeflateTop"
* | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop"
* | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted"
* | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransofrm
* | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform
* */

/**
* Axis position in the chart.
* @typedef {("top" | "bottom" | "right" | "left")} AxiePos
* @typedef {("top" | "bottom" | "right" | "left")} AxisPos
*/

/**
Expand Down Expand Up @@ -611,14 +611,14 @@
};

/**
* Creates an Ole-object with the parameters specified.
* Creates an OLE object with the parameters specified.
* @memberof Api
* @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.
* @param {string} sData - ole-object string data.
* @param {string} sAppId - the application id associated with this object.
* @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.
* @returns {ApiOleObject}
*/
Api.prototype.CreateOleObject = function(sImageSrc, nWidth, nHeight, sData, sAppId)
Expand Down Expand Up @@ -850,12 +850,12 @@
* @typeofeditors ["CPE"]
* @param {ApiTextPr} [oTextPr=Api.CreateTextPr()] - The text properties.
* @param {string} [sText="Your text here"] - The text for the Text Art object.
* @param {TextTransofrm} [sTransform="textNoShape"] - Text transform type.
* @param {TextTransform} [sTransform="textNoShape"] - Text transform type.
* @param {ApiFill} [oFill=Api.CreateNoFill()] - The color or pattern used to fill the Text Art object.
* @param {ApiStroke} [oStroke=Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the Text Art object shadow.
* @param {number} [nRotAngle=0] - Rotation angle.
* @param {EMU} [nWidth=1828800] - Text Art width measured in English measure units.
* @param {EMU} [nHeight=1828800] - Text Art heigth measured in English measure units.
* @param {EMU} [nWidth=1828800] - The Text Art width measured in English measure units.
* @param {EMU} [nHeight=1828800] - The Text Art heigth measured in English measure units.
* @param {EMU} [nIndLeft=ApiPresentation.GetWidth() / 2] - The Text Art left side indentation value measured in English measure units.
* @param {EMU} [nIndTop=ApiPresentation.GetHeight() / 2] - The Text Art top side indentation value measured in English measure units.
* @returns {ApiDrawing}
Expand Down Expand Up @@ -1688,7 +1688,7 @@
};

/**
* Returns an array with all the ole-objects from the slide master.
* Returns an array with all the OLE objects from the slide master.
* @typeofeditors ["CPE"]
* @returns {ApiOleObject[]}
* */
Expand Down Expand Up @@ -2009,7 +2009,7 @@
};

/**
* Returns an array with all the ole-objects from the slide layout.
* Returns an array with all the OLE objects from the slide layout.
* @typeofeditors ["CPE"]
* @returns {ApiOleObject[]}
* */
Expand Down Expand Up @@ -3072,7 +3072,7 @@
};

/**
* Returns an array with all the ole-objects from the slide.
* Returns an array with all the OLE objects from the slide.
* @typeofeditors ["CPE"]
* @returns {ApiOleObject[]}
* */
Expand Down Expand Up @@ -4112,10 +4112,10 @@
};

/**
* Sets the data to current Ole-object.
* Sets the data to the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @param {string} sData - ole-object string data.
* @param {string} sData - The OLE object string data.
* @returns {boolean}
*/
ApiOleObject.prototype.SetData = function(sData)
Expand All @@ -4128,7 +4128,7 @@
};

/**
* Gets the string data from current Ole-object.
* Returns the string data from the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @returns {string}
Expand All @@ -4142,10 +4142,10 @@
};

/**
* Sets the application id to current Ole-object.
* Sets the application ID to the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @param {string} sAppId - the application id associated with this object.
* @param {string} sAppId - The application ID associated with the current OLE object.
* @returns {boolean}
*/
ApiOleObject.prototype.SetApplicationId = function(sAppId)
Expand All @@ -4158,7 +4158,7 @@
};

/**
* Gets the application id from current Ole-object.
* Returns the application ID from the current OLE object.
* @memberof ApiOleObject
* @typeofeditors ["CDE", "CPE", "CSE"]
* @returns {string}
Expand Down
Loading