ApiTableOfFigures

Class representing a table of figures.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Methods

The following table lists the available methods.

Method	Returns	Description
Delete	boolean	Removes the table of figures from the document.
GetCaption	string | null	Returns the caption label that the table of figures is built from (for example, "Figure").
GetClassType	"tableOfFigures"	Returns a type of the ApiTableOfFigures class.
GetIncludeLabel	boolean	Returns whether the caption label and number are included in the table of figures entries.
GetIncludePageNumbers	boolean	Returns whether page numbers are shown in the table of figures.
GetParent	ApiDocument | null	Returns the document that contains the table of figures.
GetRange	ApiRange | null	Returns a range that covers the entire table of figures.
GetRightAlignPageNumbers	boolean	Returns whether page numbers are right-aligned in the table of figures.
GetUseHyperlinks	boolean	Returns whether entries are formatted as hyperlinks.
SetCaption	boolean	Sets the caption label that the table of figures is built from (for example, "Figure").
SetIncludeLabel	boolean	Specifies whether the caption label and number are included in the table of figures entries.
SetIncludePageNumbers	boolean	Specifies whether page numbers are shown in the table of figures.
SetPr	boolean	Applies the specified properties to the table of figures and rebuilds it.
SetRightAlignPageNumbers	boolean	Specifies whether page numbers are right-aligned in the table of figures.
SetUseHyperlinks	boolean	Specifies whether entries are formatted as hyperlinks.
Update	boolean	Updates the table of figures.