AddCaption
function AddCaption(
sAdditional: string = null,
sLabel: CaptionLabel | String = "Table",
bExludeLabel: boolean = false,
sNumberingFormat: CaptionNumberingFormat = "Arabic",
bBefore: boolean = false,
nHeadingLvl: Number = null,
sCaptionSep: CaptionSep = "hyphen",
): booleanDescription
Adds a caption paragraph after (or before) the current paragraph. 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.
Parameters
- sAdditional
stringdefault: null The additional text.
The caption label.
- bExludeLabel
booleandefault: false Specifies whether to exclude the label from the caption.
The possible caption numbering format.
- bBefore
booleandefault: false Specifies whether to insert the caption before the current paragraph (true) or after (false) (after/before the shape if it is placed in the shape).
- nHeadingLvl
Numberdefault: null The heading level (used if you want to specify the chapter number).
If you want to specify "Heading 1", then nHeadingLvl === 0 and etc. The caption separator (used if you want to specify the chapter number).
Returns
booleanTry It
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oDrawing = Api.CreateImage("https://api.onlyoffice.com/content/img/docbuilder/examples/coordinate_aspects.png", 60 * 36000, 35 * 36000);
oParagraph.AddDrawing(oDrawing);
oParagraph = Api.CreateParagraph();
oDocument.Push(oParagraph);
oParagraph.AddCaption("", "Figure", false, "Arabic", false, undefined, "hyphen");