pengjunjie/sdkjs
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/sdkjs.git synced 2026-02-10 18:15:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated plugins api docs

Browse Source
This commit is contained in:
Natalia
2025-05-29 16:14:36 +03:00
parent a164113be9
commit 66b435d177
3 changed files with 26 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
common/apiBase_plugins.js
View File

@ -1909,7 +1909,7 @@
};
/**
* Add button to the specified content controls track
* Adds a button to the specified content controls track.
* @undocumented
* @memberof Api
* @typeofeditors ["CDE"]
@ -1993,7 +1993,7 @@
};
/**
* Update an item to the toolbar menu.
* Updates the toolbar menu item.
* @undocumented
* @memberof Api
* @typeofeditors ["CDE", "CSE", "CPE"]
@ -2165,7 +2165,7 @@
};
/**
* Catch AI event from plugin
* Catch AI event from plugin.
* @memberof Api
* @undocumented
* @typeofeditors ["CDE", "CSE", "CPE", "PDF"]
@ -2185,7 +2185,7 @@
};
/**
* Get local image path for image.
* Returns the local path to the image.
* @memberof Api
* @undocumented
* @typeofeditors ["CDE", "CSE", "CPE", "PDF"]

36
pdf/api_plugins.js
View File

@ -35,16 +35,16 @@
(function(window, undefined)
{
/**
* Options for replace page content by html
* Options to replace the HTML page content.
* @typedef {Object} ReplaceHtmlOptions
* @property {string} content - html content to replace
* @property {boolean} [separateParagraphs=true] - will each paragraph be created a separate shape
* @property {string} content - The HTML content to replace.
* @property {boolean} [separateParagraphs=true] - Specifies whether each paragraph will be created in a separate shape.
*/
/**
* Options for replace page content by html
* Options to replace the XML page content.
* @typedef {Object} ReplaceXmlOptions
* @property {string[]} content - array with xml shapes to replace
* @property {string[]} content - An array with XML shapes to be replaced.
*/
@ -57,7 +57,7 @@
let Api = window["asc_docs_api"];
/**
* Gets current page index
* Returns the current page index.
* @memberof Api
* @typeofeditors ["PDFE"]
* @alias GetCurrentPage
@ -69,16 +69,16 @@
};
/**
* Gets page image
* Returns the page image.
* @memberof Api
* @typeofeditors ["PDFE"]
* @alias GetPageImage
* @param {number} nPage - page index
* @param {object} [oParams={}] - image params
* @param {number} [oParams.maxSize] - the size of the larger side in pixels
* @param {boolean} [oParams.annotations=false] - will annotations be rendered
* @param {boolean} [oParams.fields=false] - will fields be rendered
* @param {boolean} [oParams.drawings=false] - will drawings be rendered
* @param {number} nPage - The page index.
* @param {object} [oParams={}] - The image parameters.
* @param {number} [oParams.maxSize] - The size of the larger image side in pixels.
* @param {boolean} [oParams.annotations=false] - Specifies whether the annotations will be rendered.
* @param {boolean} [oParams.fields=false] - Specifies whether the fields will be rendered.
* @param {boolean} [oParams.drawings=false] - Specifies whether the drawings will be rendered.
* @returns {canvas}
* @see office-js-api/Examples/Plugins/PDF/Api/Methods/GetPageImage.js
*/
@ -145,14 +145,14 @@
};
/**
* Replace page content by params
* Replaces the page content with the specified parameters.
* @memberof Api
* @typeofeditors ["PDFE"]
* @alias ReplacePageContent
* @param {number} nPage - page index
* @param {object} oParams - replace params
* @param {"xml" | "html"} oParams.type - type of content to replace (xml / html)
* @param {ReplaceXmlOptions | ReplaceHtmlOptions} oParams.options - replace content options
* @param {number} nPage - The page index.
* @param {object} oParams - The replacement parameters.
* @param {"xml" | "html"} oParams.type - The type of content to be replaced (XML / HTML).
* @param {ReplaceXmlOptions | ReplaceHtmlOptions} oParams.options - The content replacement options.
* @returns {boolean}
* @see office-js-api/Examples/Plugins/PDF/Api/Methods/ReplacePageContent.js
*/

7
word/api_plugins.js
View File

@ -126,10 +126,11 @@
*/
/**
* Content control list element
* The content control list element.
* @typedef {Object} ContentControlListElement
* @property {string} Display - element display text
* @property {string} Value - element value
* @property {string} Display - The element display text.
* @property {string} Value - The element value.
* @see office-js-api/Examples/Plugins/{Editor}/Enumeration/ContentControlListElement.js
*/
var Api = window["asc_docs_api"];