Row
The row object describes one or many rows on a sheet. A row is added after the previous one if not defined otherwise using ‘pos’.
Examples
"rows": [
{
"values": [ "Title", "Firstname", "Lastname", "Email"],
"format": {
"fontRef": "Standard-bold",
"backgroundColor": {"rgb": [160,210,255]}
}
},
{
"path": "tmp/export.xlsx",
"fields": ["Title", "First Name", "Last Name", "Email Addresses::Address"],
"type": "data"
}
]
Implementations
Properties
name | type | description |
---|---|---|
contentType | string | Content Type in Source File or Field possible values: json csv tab |
fields | array | Filter Data Source by Column Names. Determines which fields from the source shall be in the target file. References the header names. Array Items: string minItems: 1 |
includeFirstRow | boolean | Import first row from source. When processing a source file and the target row is on pos:1 (second row), the source's first row is omitted as it usually contains column headers. If your source file's data starts in row 0 or you want to export the original headers you have to set includeFirstRow: true .default: false |
limit | integer | Limit number of rows processed from source. |
offset | integer | Row to start processing the source file. |
path | string | File path to a source file providing data. |
type | string | Rows can be of type header, data or summary. Choosing one applies specific formattings. possible values: header data summary |
widths | array | Specify Columns Widths, use -1 for 'auto'. The unit is character. To specify the width for all columns, set Default Column Width in sheet or workbook. Width items per column, from left to right. Array Items: width - integer |
formatRef | string | Reference to a named format. |
format | object | Format Options Format |
height | integer | Set the row height in points. |
pos | integer | Position of row. Starting row position. First row is pos 0. minimum:0 |
array | Array containing start and length of row. First row is pos 0. Array Items: start integer minimum:0length integer minimum:0 | |
values | array | Values array for each row. minItems:1 Standard Value Data Types OR Array of Standard Value Data Types Array Items: string OR integer OR boolean OR Array[string OR integer OR boolean] |
valuesRef | string | Reference to central value storage. |