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

[de] Add description for new methods and events related to text annotations

Browse Source
This commit is contained in:
Ilya Kirillov
2025-12-08 19:25:45 +03:00
parent 1e4b6e1dce
commit d3a855ac35
2 changed files with 91 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
word/api_plugins.js
View File

@ -133,6 +133,21 @@
* @see office-js-api/Examples/Plugins/{Editor}/Enumeration/ContentControlListElement.js
*/
/**
* @typedef {Object} TextAnnotation
* @property {string} paragraphId - ID of the paragraph containing the annotation.
* @property {string} rangeId - ID of the annotation range.
* @property {string} [name] - Annotation type (e.g., `"grammar"`).
*/
/**
* @typedef {Object} TextAnnotationRange
* @property {string} id - Unique identifier for the range.
* @property {number} start - Starting index of the text range.
* @property {number} length - Length of the text range.
* @property {string} [name] - Annotation type (e.g., `"grammar"`).
*/
var Api = window["asc_docs_api"];
/**
@ -1304,69 +1319,61 @@
return bookmarks.GetBookmarkByDocPos(docPos);
};
/**
* Annotate the specified paragraph.
* Adds annotations to the specified paragraph.
* @memberof Api
* @typeofeditors ["CDE"]
* @alias AnnotateParagraph
* @param {Object} obj - The response object containing annotation data
* @param {string} obj.type - The type of annotation operation (e.g., "highlightText")
* @param {string} [obj.name] - Optional name of the annotation
* @param {string} obj.paragraphId - ID of the paragraph being annotated (for highlightText type)
* @param {string} obj.recalcId - Recalculation ID for validation (for highlightText type)
* @param {Array<{start: number, length: number, id: string}>} [obj.ranges] - Array of text ranges to highlight (for highlightText type)
* @param {number} obj.ranges[].start - Starting index of the text range
* @param {number} obj.ranges[].length - Length of the text range
* @param {string} obj.ranges[].id - Unique identifier for the range
* @param {Object} data - Annotation data specifying what to annotate.
* @param {string} data.type - The type of annotation operation (e.g., `"highlightText"`).
* @param {string} [data.name] - Optional name of the annotation.
* @param {string} data.paragraphId - ID of the paragraph being annotated.
* @param {string} data.recalcId - Paragraph recalculation ID.
* @param {Array<TextAnnotationRange>} [data.ranges] - Array of text ranges to highlight (for highlightText type)
* @since 9.2.0
* @see office-js-api/Examples/Plugins/{Editor}/Api/Methods/AnnotateParagraph.js
*/
Api.prototype["pluginMethod_AnnotateParagraph"] = function(obj)
Api.prototype["pluginMethod_AnnotateParagraph"] = function(data)
{
if (!obj)
if (!data)
return;
obj["guid"] = window.g_asc_plugins.getCurrentPluginGuid();
this.getTextAnnotatorEventManager().onResponse(obj);
data["guid"] = window.g_asc_plugins.getCurrentPluginGuid();
this.getTextAnnotatorEventManager().onResponse(data);
};
/**
* Selects a specific annotation range in the document.
* Selects text in a document using a given annotation.
* @memberof Api
* @typeofeditors ["CDE"]
* @alias AnnotateParagraph
* @param {Object} obj - The range selection object
* @param {string} obj.paragraphId - ID of the paragraph containing the annotation
* @param {string} obj.rangeId - ID of the specific range to select
* @param {string} [obj.name] - Optional name/type of the annotation (e.g., "grammar", "spelling", etc.)
* @alias SelectAnnotationRange
* @param {TextAnnotation} annotation - The annotation selection object.
* @since 9.2.0
* @see office-js-api/Examples/Plugins/{Editor}/Api/Methods/SelectAnnotationRange.js
*/
Api.prototype["pluginMethod_SelectAnnotationRange"] = function(obj)
Api.prototype["pluginMethod_SelectAnnotationRange"] = function(annotation)
{
if (!obj)
if (!annotation)
return;
obj["guid"] = window.g_asc_plugins.getCurrentPluginGuid();
this.getTextAnnotatorEventManager().selectRange(obj);
annotation["guid"] = window.g_asc_plugins.getCurrentPluginGuid();
this.getTextAnnotatorEventManager().selectRange(annotation);
};
/**
* Remove a specific annotation range from the document.
* @memberof Api
* @typeofeditors ["CDE"]
* @alias RemoveAnnotationRange
* @param {Object} obj - The range removing object
* @param {string} obj.paragraphId - ID of the paragraph containing the annotation
* @param {string} obj.rangeId - ID of the specific range to remove
* @param {string} [obj.name] - Optional name/type of the annotation (e.g., "grammar", "spelling", etc.)
* @param {TextAnnotation} annotation - The annotation removing object.
* @param {boolean} [annotation.all=false] - Optional parameter, flag to remove all annotations for the current paragraph.
* @since 9.2.0
* @see office-js-api/Examples/Plugins/{Editor}/Api/Methods/RemoveAnnotationRange.js
*/
Api.prototype["pluginMethod_RemoveAnnotationRange"] = function(obj)
Api.prototype["pluginMethod_RemoveAnnotationRange"] = function(annotation)
{
if (!obj)
if (!annotation)
return;
obj["guid"] = window.g_asc_plugins.getCurrentPluginGuid();
this.getTextAnnotatorEventManager().removeRange(obj);
annotation["guid"] = window.g_asc_plugins.getCurrentPluginGuid();
this.getTextAnnotatorEventManager().removeRange(annotation);
};
function private_ReadContentControlCommonPr(commonPr)

52
word/plugin-events.js
View File

@ -204,3 +204,55 @@
* @see office-js-api/Examples/Plugins/{Editor}/Plugin/Events/onInsertOleObjects.js
*/
/**
* Event: onBlurAnnotation
* @event Plugin#onBlurAnnotation
* @memberof Plugin
* @typeofeditors ["CDE"]
* @alias onBlurAnnotation
* @since 9.2.0
* @description The function called when an annotation loses focus.
* @param {TextAnnotation} annotation - The annotation that lost focus.
* @see office-js-api/Examples/Plugins/{Editor}/Plugin/Events/onBlurAnnotation.js
*/
/**
* Event: onFocusAnnotation
* @event Plugin#onFocusAnnotation
* @memberof Plugin
* @typeofeditors ["CDE"]
* @alias onFocusAnnotation
* @since 9.2.0
* @description The function called when an annotation receives focus.
* @param {TextAnnotation} annotation - The annotation that received focus.
* @see office-js-api/Examples/Plugins/{Editor}/Plugin/Events/onFocusAnnotation.js
*/
/**
* Event: onClickAnnotation
* @event Plugin#onClickAnnotation
* @memberof Plugin
* @typeofeditors ["CDE"]
* @alias onClickAnnotation
* @since 9.2.0
* @description The function called when the user clicks an annotation.
* @param {TextAnnotation} annotation - The annotation that was clicked.
* @see office-js-api/Examples/Plugins/{Editor}/Plugin/Events/onClickAnnotation.js
*/
/**
* Event: onParagraphText
* @event Plugin#onParagraphText
* @memberof Plugin
* @typeofeditors ["CDE"]
* @alias onParagraphText
* @since 9.2.0
* @description The function called when the paragraph text is updated in the document.
* @param {Object} data - Event data containing information about the updated paragraph.
* @property {string} data.paragraphId - ID of the paragraph whose content was changed.
* @property {string} data.recalcId - ID of the last paragraph recalculation.
* @property {string} data.text - The updated text content of the paragraph.
* @property {TextAnnotationRange[]} data.annotations - Array of updated annotation ranges.
* @see office-js-api/Examples/Plugins/{Editor}/Plugin/Events/onParagraphText.js
*/