ApiTableOfFigures

表示图表目录的类。

备注

此功能仅在 ONLYOFFICE Docs 付费版本中可用。

方法

下表列出了可用的方法。

方法	返回值	描述
Delete	boolean	从文档中移除图表目录。
GetCaption	string | null	返回生成图表目录所依据的题注标签（例如，"Figure"）。
GetClassType	"tableOfFigures"	返回 ApiTableOfFigures 类的类型。
GetIncludeLabel	boolean	返回图表目录条目中是否包含题注标签和编号。
GetIncludePageNumbers	boolean	返回图表目录中是否显示页码。
GetParent	ApiDocument | null	返回包含该图表目录的文档。
GetRange	ApiRange | null	返回覆盖整个图表目录的范围。
GetRightAlignPageNumbers	boolean	返回图表目录中的页码是否右对齐。
GetUseHyperlinks	boolean	返回条目是否设置为超链接格式。
SetCaption	boolean	设置生成图表目录所依据的题注标签（例如，"Figure"）。
SetIncludeLabel	boolean	指定图表目录条目中是否包含题注标签和编号。
SetIncludePageNumbers	boolean	指定是否在图表目录中显示页码。
SetPr	boolean	将指定属性应用于图表目录并重新生成图表目录。
SetRightAlignPageNumbers	boolean	指定图表目录中的页码是否右对齐。
SetUseHyperlinks	boolean	指定是否将条目设置为超链接格式。
Update	boolean	更新图表目录。