文章来源于网络收集而来，版权归原创者所有，如有侵权请及时联系！

Document v3

发布于 2023-04-06 17:51:14 字数 25073 浏览 0 评论 0 收藏 0

参数说明： 腾讯文档 Doc 文档内容

{
  "document": object(Document)
}

参数名称类型描述

document

object(Node

参数说明： 构成文档内容的节点

{
  "begin": integer,
  "end": integer,
  "property": object(Property),
  "type": string,
  "children": []object(Node),
  "text": string
}

参数名称类型描述

begin integer 起始位置

end integer 结束位置

property

object(Type

参数名称	描述
Document	Doc 文档
MainStory	文档主节点，文档主体内容
Section	节
Paragraph	段落
Table	表格
TableRow	表格行
TableCell	表格单元格
Text	一个具有相同属性集合的文本容器
Drawing	图形化对象 , 例如图表、图片等
Footnote	脚注
Endnote	尾注
Comment	批注
CommentRef	批注引用
TextBox	文本框
Footer	页脚
Header	页眉

Property

参数说明： 表示文档节点的样式。详见

[Office Open XML File Formats — Fundamentals and Markup Language Reference]

{
  "sectionProperty": object(SectionProperty),
  "paragraphProperty":object(ParagraphProperty),
  "runProperty": object(RunProperty),
  "tableProperty":object(TableProperty),
  "tableRowProperty": object(TableRowProperty),
  "tableCellProperty":object(TableCellProperty),
  "textBoxProperty": object(TextBoxProperty),
  "drawingProperty":object(DrawingProperty),
  "commentStoryProperty": object(CommentProperty),
  "makeupProperty":object(CommentReferenceProperty),
  "footnoteProperty": object(FootnoteProperty),
  "endnoteProperty":object(EndnoteProperty),
  "footnoteOrEndnoteReferenceProperty": object(FootnoteOrEndnoteReferenceProperty),
  "headerProperty":object(HeaderProperty),
  "footerProperty": object(FooterProperty)
}

参数名称参数类型描述

sectionProperty

SectionProperty

section 类型节点的属性

{
  "headerReference": object(headerfooterreference),
  "footerReference": object(headerfooterreference),
  "pageSize":  object(PageSize),
  "pageMargins": object(PageMargins)
}

参数名称参数类型描述

headerReference

object(HeaderFooterReference

"headerReference": {
    "STHdrFtr_default": object(STHdrFtr)
}

参数名称参数类型描述

STHdrFtr_default

object(STHdrFtr

{
    "id": "string",
    "type": "string"
}

参数名称参数类型描述

id string 被引用的页眉或页脚的 ID

type

HeaderFooterType

参数名称	枚举值	描述
HEADER_FOOTER_TYPE_UNSPECIFIED	0	未知
HEADER_FOOTER_TYPE_EVEN	1	均匀
HEADER_FOOTER_TYPE_DEFAULT	2	默认
HEADER_FOOTER_TYPE_FIRST	3	行首

PageSize

用于描述页面的大小

{
  "width": double,
  "height":double,
  "orientation": object(PageOrientation)
}

参数名称参数类型描述

width double 页面宽度

height double 页面高度

orientation

PageOrientation

页面方向，指定了当前 Section 页面方向。默认的页面方向是纵向。

参数名称	枚举值	描述
PAGE_ORIENTATION_UNSPECIFIED	0	未知
PAGE_ORIENTATION_PORTRAIT	1	纵向
PAGE_ORIENTATION_LANDSCAPE	2	横向

PageMargins

页边距，指定了一个 Section 中所有页面的页边距属性

{
  "top": double,
  "right": double,
  "bottom": double,
  "left": double
}

参数名称	参数类型	描述
top	double	上边距
right	double	右边距
bottom	double	下边距
left	double	左边距

ParagraphProperty

段落属性

{
  "numberProperty":object(NumberProperty),
  "spacing": object(Spacing),
  "indent":object(Indent),
  "alignmentType": object(AlignmentType),
  "textDirection":object(TextDirection)
}

参数名称参数类型描述

numberProperty

NumberProperty

段落的编号属性，描述该段落的项目符号、数字编号

{
  "nestingLevel": integer,
  "numberId": string
}

参数名称	参数类型	描述
nestingLevel	integer	编号缩进层级
numberId	string	编号 ID，一个列表中的每个段落编号 ID 相同

Spacing

段落间距

{
  "before": double,
  "after":double,
  "line": double,
  "lineRule":object(LineSpacingRule),
}

参数名称参数类型描述

before double 段后间距，单位是像素（px）

after double 段前间距，单位是像素（px）

line double 行间距数值，单位是像素（px）

lineRule

LineSpacingRule

行间距规则

参数名称	枚举值	描述
LINE_SPACING_RULE_UNSPECIFIED	0	未知
LINE_SPACING_RULE_AUTO	1	自动
LINE_SPACING_RULE_EXACT	2	精确值
LINE_SPACING_RULE_AT_LEAST	3	最小行间距

Indent

段落缩进

{
  "left": double,
  "leftChars":integer,
  "right": double,
  "rightChars":integer,
  "hanging": double,
  "hangingChars":integer,
  "firstLine": double,
  "firstLineChars":integer,
}

参数名称	参数类型	描述
left	double	缩进左侧，单位是像素（px）
leftChars	integer	缩进左侧字符数，单位 1/20 字符宽度
right	double	缩进右侧，单位是像素（px）
rightChars	integer	缩进右侧字符数，单位 1/20 字符宽度
hanging	double	垂直悬挂，单位是像素（px）
hangingChars	integer	垂直悬挂字符数，单位 1/20 字符宽度
firstLine	double	首行缩进，单位是像素（px）
firstLineChars	integer	首行缩进字符数，单位 1/20 字符宽度

AlignmentType

水平方向对齐类型

Name	枚举值	描述
ALIGNMENT_TYPE_UNSPECIFIED	0	未知
ALIGNMENT_TYPE_CENTER	2	指定文本应以文档中两个文本边距之间的中线为中心
ALIGNMENT_TYPE_BOTH	4	指定文本应在文档的两个文本边距之间对齐
ALIGNMENT_TYPE_DISTRIBUTE	6	指定文本应在文档的两个文本边距之间对齐，这种对齐方式会增加一行中每个字符中间的距离
ALIGNMENT_TYPE_LEFT	11	指定文本对齐文档的左边距
ALIGNMENT_TYPE_RIGHT	12	指定文本对齐文档的右边距

TextDirection

文字方向类型枚举

参数名称	枚举值	描述
TEXT_DIRECTION_UNSPECIFIED	0	未知
TEXT_DIRECTION_RIGHT_TO_LEFT	1	从右至左
TEXT_DIRECTION_LEFT_TO_RIGHT	2	从左至右

RunProperty

定义了一系列 text 的属性

{
  "font": string,
  "bold": bool,
  "italics": bool, 
  "underline": bool,
  "strike": bool,
  "color": string,
  "spacing": double, 
  "size": double,
  "shading": object(Shading),
  "verticalAlign": object(TextVerticalAlign),
  "isPlaceholder": bool
}

Field Type Description

font string 字体

bold bool 文字是否加粗

italics bool 文字是否斜体表示

underline bool 文字是否下划线

strike bool 文字是否被删除线贯穿

color

string

文字的颜色，颜色使用十六进制，Shading

阴影

{
  "foregroundColor": string,
  "backgroundColor": string
}

参数名称参数类型描述

foregroundColor

string

前景色，颜色使用十六进制 TextVerticalAlign

竖直对齐类型枚举

参数名称	枚举值	描述
RUN_VERTICAL_ALIGN_UNSPECIFIED	0	未知
RUN_VERTICAL_ALIGN_BASELINE	1	对齐基线
RUN_VERTICAL_ALIGN_SUPER_SCRIPT	2	上标
RUN_VERTICAL_ALIGN_SUB_SCRIPT	3	下标

TableProperty

表格属性，指定了一组表格宽度的属性。这个属性对所有的表格行和表格单元都会生效，但是可以被表格行和表格单元的属性覆盖。

{
  "tableWidth": object(TableWidth),
  "horizontalAlignmentType": object(TableHorizontalAlignmentType),
  "tableLayout": object(TableLayoutType)
}

参数名称参数类型描述

tableWidth

TableWidth

表格宽度，指定该表的首选宽度。

{
  "width": double,
  "type": object(TableWidthType)
}

参数名称参数类型描述

width double 表格宽度，单位是像素（px）

type

TableHorizontalAlignmentType

表格的水平对齐的方式

参数名称	枚举值	描述
TABLE_HORIZONTAL_ALIGNMENT_TYPE_UNSPECIFIED	0	未知
TABLE_HORIZONTAL_ALIGNMENT_TYPE_CENTER	1	指定当前表格位于一行的中间位置
TABLE_HORIZONTAL_ALIGNMENT_TYPE_LEFT	3	与文字边缘的左侧对齐
TABLE_HORIZONTAL_ALIGNMENT_TYPE_START	5	与文字边缘的右侧对齐

TableLayoutType

表格布局类型枚举

参数名称	枚举值	描述
TABLE_LAYOUT_TYPE_UNSPECIFIED	0	未知
TABLE_LAYOUT_TYPE_FIXED	1	固定宽度
TABLE_LAYOUT_TYPE_AUTO_FIT	2	自适应布局

TableWidthType

表格宽度类型

参数名称	枚举值	描述
TABLE_WIDTH_TYPE_UNSPECIFIED	0	未知
TABLE_WIDTH_TYPE_NIL	1	当前宽度为 0
TABLE_WIDTH_TYPE_PERCENTAGE	2	宽度值是百分比
TABLE_WIDTH_TYPE_DAX	3	宽度值的单位是缇（1/1440 英寸）
TABLE_WIDTH_TYPE_AUTO	4	自动宽度，前表宽度属性的度量值由自适应算法确定

TableRowProperty

表格行属性

{
  "isHeader": bool
}

参数名称	参数类型	描述
isHeader	bool	本行是否是表头

TableCellProperty

表格单元属性

{
  "tableCellBorders": object(Borders),
  "verticalAlignment": object(VerticalAlignment)
}

参数名称参数类型描述

tableCellBorders

Borders

表格单元的边界属性

{
  "top": object(BorderProperty),
  "left": object(BorderProperty),
  "bottom": object(BorderProperty),
  "right": object(BorderProperty)
}

参数名称参数类型描述

top

BorderProperty

边界属性

{
  "color" : string,
  "width" : integer
}

参数名称参数类型描述

color

string

边界颜色，颜色使用十六进制 VerticalAlignment

垂直方向对齐属性

参数名称	枚举值	描述
VERTICAL_ALIGNMENT__UNSPECIFIED	0	未知
VERTICAL_ALIGNMENT_TOP	1	对齐顶部
VERTICAL_ALIGNMENT_CENTER	2	居中对齐
VERTICAL_ALIGNMENT_BOTH	3	自适应对齐
VERTICAL_ALIGNMENT_BOTTOM	4	对齐底部

TextBoxProperty

文本块节点的属性

{
  "id": string,
  "isCodeBlock": bool,
  "wordWrap": bool
}

参数名称	参数类型	描述
id	string	文本块 ID
isCodeBlock	bool	代码块标志
wordWrap	bool	自动换行

DrawingProperty

一张图片、一个高亮文本框属于 Drawing 类型

{
  "inlineKeyword": object(Inline),
  "isPlaceholder": bool
}

参数名称参数类型描述

inlineKeyword

Inline

Drawing 类型中的实体，如一张图片

{
  "picture": object(InlinePicture),
  "addon": object(InlineAddon)
}

参数名称参数类型描述

picture

InlinePicture

{
  "uri": string,
  "relativeRect": object(RelativeRect),
  "shape": object(ShapeProperties)
}

参数名称参数类型描述

uri string 图片链接

relativeRect

RelativeRect

{
  "left": integer,
  "top": integer,
  "right": integer,
  "bottom": integer
}

参数名称	参数类型	描述
left	integer	距左侧的距离，单位系数是 0.001%（例如：75000 代表 75%）
top	integer	距顶部的距离，单位系数是 0.001%（例如：75000 代表 75%）
right	integer	距右侧的距离，单位系数是 0.001%（例如：75000 代表 75%）
bottom	integer	距底部的距离，单位系数是 0.001%（例如：75000 代表 75%）

ShapeProperties

{
  "transform": object(Transform2D)
}

参数名称参数类型描述

transform

Transform2D

{
  "extent":{
    "cx": integer,
    "cy": integer
  },
  "rotation": integer
}

参数名称参数类型描述

extent

object(PositiveSize2D

{
  "cx": integer,
  "cy": integer
}

参数名称	参数类型	描述
cx	integer	图片宽，单位是像素（px）
cy	integer	图片高，单位是像素（px）

InlineAddon

{
  "addonId": string,
  "addonSource": AddonSourceType
}

参数名称参数类型描述

addonId string 插件 ID

addonSource

AddonSourceType

参数名称	枚举值	描述
ADDON_SOURCE_TYPE_UNSPECIFIED	0	未知
ADDON_SOURCE_TYPE_NONE	1	无
ADDON_SOURCE_TYPE_LATEX	2	公式
ADDON_SOURCE_TYPE_SIGN	3	签名
ADDON_SOURCE_TYPE_SIGN_BAR	4	签名占位图

Anchor

Drawing 类型中浮动的实体，如一张图片

{
  "picture": object(InlinePicture),
}

参数名称参数类型描述

picture

AnchorPicture

{
  "uri": string,
  "relativeRect": object(RelativeRect),
  "shape": object(ShapeProperties)
}

参数名称参数类型描述

uri string 图片链接

relativeRect

PositionHorizontal

参数名称参数类型描述

posOffset integer 位置偏移

relativeFrom

RelativeFromHorizontal

参数名称	枚举值	描述
RELATIVE_FROM_HORIZONTAL_UNSPECIFIED	0	未知
RELATIVE_FROM_HORIZONTAL_MARGIN	1	边缘
RELATIVE_FROM_HORIZONTAL_PAGE	2	页
RELATIVE_FROM_HORIZONTAL_COLUMN	3	列
RELATIVE_FROM_HORIZONTAL_CHARACTER	4	字符
RELATIVE_FROM_HORIZONTAL_LEFT_MARGIN	5	左边缘
RELATIVE_FROM_HORIZONTAL_RIGHT_MARGIN	6	右边缘
RELATIVE_FROM_HORIZONTAL_INSIDE_MARGIN	7	内部边缘
RELATIVE_FROM_HORIZONTAL_OUTSIDE_MARGIN	8	外部边缘

PositionVertical

参数名称参数类型描述

posOffset integer 位置偏移

relativeFrom

RelativeFromVertical

参数名称	枚举值	描述
RELATIVE_FROM_VERTICAL_UNSPECIFIED	0	未知
RELATIVE_FROM_VERTICAL_MARGIN	1	边缘
RELATIVE_FROM_VERTICAL_PAGE	2	页
RELATIVE_FROM_VERTICAL_PARAGRAPH	3	段
RELATIVE_FROM_VERTICAL_LINE	4	线
RELATIVE_FROM_VERTICAL_TOP_MARGIN	5	顶端边缘
RELATIVE_FROM_VERTICAL_BOTTOM_MARGIN	6	底部边缘
RELATIVE_FROM_VERTICAL_INSIDE_MARGIN	7	内部边缘
RELATIVE_FROM_VERTICAL_OUTSIDE_MARGIN	8	外部边缘

WrapSquare

参数名称参数类型描述

wrapText

WrapText

参数名称	枚举值	描述
WRAP_TEXT_BOTH_UNSPECIFIED	0	未知
WRAP_TEXT_BOTH_SIDES	1	两边
WRAP_TEXT_LEFT	2	左边
WRAP_TEXT_RIGHT	3	右边
WRAP_TEXT_LARGEST	4	最大

CommentProperty

批注类型节点的属性

{
  "id": string,
  "date": string,
  "editDate": string,
  "avatar": string,
  "refId": string
}

参数名称	参数类型	描述
id	string	批注 ID
date	string	批注日期，13 位时间戳
editDate	string	编辑日期，13 位时间戳
avatar	string	批注人头像
refId	string	批注位置 ID

CommentReferenceProperty

批注引用类型节点的属性

参数名称	参数类型	描述
id	string	批注引用 ID

FootnoteProperty

脚注类别节点属性

参数名称	参数类型	描述
id	string	脚注 ID

EndnoteProperty

尾注类型节点的属性

参数名称	参数类型	描述
id	string	尾注 ID

FootnoteOrEndnoteReferenceProperty

脚注和尾注的引用

参数名称	参数类型	描述
id	string	引用的脚注或尾注 ID

HeaderProperty

页眉节点属性值

参数名称	参数类型	描述
id	string	页眉 ID

FooterProperty

页脚类型节点属性值

参数名称	参数类型	描述
id	string	页脚 ID

格式

RRGGBB

颜色使用 RGB 颜色空间表示。格式为 DEFABC （每一位是一个十六进制数值），前两位代表红色，中间两位代表绿色，最后两位代表表蓝色。例如当前两位为10时，红色值为32；当返回值为 0000FF 代表蓝色。参考资料 (opens new window)

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

列表为空，暂无数据

我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的隐私政策了解更多相关信息。单击 接受 或继续使用网站，即表示您同意使用 Cookies 和您的相关数据。

原文

Document v3

Property

PageSize

PageMargins

ParagraphProperty

Spacing

Indent

AlignmentType

TextDirection

RunProperty

TableProperty

TableLayoutType

TableWidthType

TableRowProperty

TableCellProperty

TextBoxProperty

DrawingProperty

ShapeProperties

InlineAddon

Anchor

PositionVertical

WrapSquare

CommentProperty

CommentReferenceProperty

FootnoteProperty

EndnoteProperty

FootnoteOrEndnoteReferenceProperty

HeaderProperty

FooterProperty

格式

RRGGBB

如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。