数据格式规范

文因互联自动化API的主要目的是降低报告自动生成的成本,提供数据即报告的模式。在本节内容中,主要定义数据格式规范。

格式概述

整个报告数据是一个列表数据,列表中的每一个数据由一个字典型数据构成,该字典型数据实际意义是报告中的一个模块(module),每一个模块由3对键值组成:标题(title)、布局(layout)和数据(data)组成。其中布局用来描述每一个数据元素的展示方式,因此布局和数据均为两个等长的列表。示例如下:

[{
    'title': '示例数据',
    'layout': ['text'],
    'data': [
        ['这是一个文本数据,表现为一个自然段落。']
    ]
}]

标题

在每一个模块中,至多有一个标题,标题内容作为模块的title键的值存在,该值是一个字符串类型。在doc文档显示中,该值显示为一个章节的标题,以仅次于报告主标题的形式突出显示,变现为加粗和大字体。在ppt文档中展示为上方标题。

布局和数据

布局用来描述每一个数据如何展示,包括以下布局:text、bullet、table、chart、sectioncover和pagebreak。每一个模块可以是不同布局和数据混合组成,比如:

[{
    'title': '这是标题',
    'layout': ['text'],
    'data': [
        [
            '这是普通文字',
            '这是普通文字第二段'
        ]
    ]    
}]

text

普通文本型数据,在报告中展现为一段文字,支持有限的加粗、超链接、斜体。默认段首自动缩进,也可以通过添加标签来禁止段首缩进。

table

在报告中展现为一个表格。

chart

在报告中展现为一个图,图形允许报告生成后直接编辑和修改。

sectioncover

在ppt中展现为一个章节,会出现一个新的章节标题;在doc中表现为一个篇章切割,主要表现为不同的篇章允许不同的页面展示,比如不同的页面分栏和页面布局方向。

pagebreak

在ppt中无明显效果,在doc中表现为强行分页。

报告中用到的几种数据格式: