SuggestionFormatData
typedef
Command parameters and additional suggestion parameters. Passed value is also saved in
Suggestion#data
property.
Properties
-
[i: string] : unknown
module:track-changes/trackchangesediting~SuggestionFormatData#__index[0]
-
commandName : string
module:track-changes/trackchangesediting~SuggestionFormatData#commandName
Name of the command to execute when the suggestion is accepted.
-
commandParams : Array<any>
module:track-changes/trackchangesediting~SuggestionFormatData#commandParams
Parameters with which the command should be executed.
-
formatGroupId : string | undefined
module:track-changes/trackchangesediting~SuggestionFormatData#formatGroupId
Additional grouping parameter for suggestions. If a suggestion would be set on an element which already has a different suggestion with the same
formatGroupId
, the new suggestion will overwrite the old one (the old one will be removed). Defaults tocommandName
parameter, so different suggestions of the same command overwrite each other. Using this parameter you might expand this behavior so that multiple commands overwrite each other. -
multipleBlocks : boolean | undefined
module:track-changes/trackchangesediting~SuggestionFormatData#multipleBlocks
True when format suggestion uses ranges.