Spreadsheet Properties (Object)
- Stephan Böhmig
Represents properties of a spreadsheet as a JSON object:
- The spreadsheet columns in node columns. The columns of the layout enriched with additional properties.
- The layout used in node layout. These are the columns that you requested.
- All data that can be added to the layout of the spreadsheet in node allfields
PROPERTIES
The JSON object contains:
| columns | An array of the columns that make up the actual spreadsheet. The columns are typically the same as the layout you submitted. However, the system will eliminate any data columns to which the current user does not have access. For example, if the user can see English and French content, a layout column for Spanish will be dropped automatically. The authorized columns depend on the access rights, see Rights (Object). See Spreadsheet Column (Object) for the properties of each item. Example with a French translation column: [
{
"index": 0,
"fkey": "1~fr~0",
"fkeyLayout": "1~#0~0",
"ftype": 1,
"fqualifier": 0,
"name": "Français",
"loc": "fr",
"loc_rtl": false,
"loc_cmplx": false,
"loc_ea": false
},
{ ... }
]
| object[] |
| layout | An object with the layout that was used to configure the spreadsheet. The layout consists of an optional name and a list of columns. See Spreadsheet Layout (Object) for details. Example: {
"name": null,
"columns": [
{ "fkey": "1~en~0" },
{ "fkey": "1~fr~0" }
]
}
| object |
| allfields | A list of all columns to which a user has access. This list can for example be used to let a user add more columns to the spreadsheet. You would then build a new layout. Each array item ressembles the properties of the Spreadsheet Column (Object) and includes these properties:
| object[] |
| lasteditors | All available "last editors". The "last editor" specifies the source or origin of a translation: Human edit, pre-translation, machine translation etc. See example below. |
EXAMPLES
The properties for a 2 column spreadsheet may look like this:
{
"columns": [
{
"index": 0,
"fkey": "1~fr~0",
"fkeyLayout": "1~#0~0",
"ftype": 1,
"fqualifier": 0,
"name": "Français",
"loc": "fr",
"loc_rtl": false,
"loc_cmplx": false,
"loc_ea": false
},
{
"index": 1,
"fkey": "1~en~0",
"fkeyLayout": "1~#1~0",
"ftype": 1,
"fqualifier": 0,
"name": "Anglais",
"loc": "en",
"loc_rtl": false,
"loc_cmplx": false,
"loc_ea": false
}
],
"layout": {
"name": null,
"columns": [
{
"ftype": 1,
"loc": "#0",
"canEdit": true,
"fqualifier": 0,
"fkey": "1~#0~0"
},
{
"ftype": 1,
"loc": "#1",
"canEdit": true,
"fqualifier": 0,
"fkey": "1~#1~0"
}
]
},
"allfields": [
{
"fkey": "2~~0",
"ftype": 2,
"fqualifier": 0,
"loc": null,
"loct": null,
"name": "Context"
},
{
"fkey": "7~~1",
"ftype": 7,
"fqualifier": 1,
"loc": null,
"loct": null,
"name": "String"
},
{
"fkey": "7~~2",
"ftype": 7,
"fqualifier": 2,
"loc": null,
"loct": null,
"name": "Pick list field"
},
{
"fkey": "7~~3",
"ftype": 7,
"fqualifier": 3,
"loc": null,
"loct": null,
"name": "Pick list, custom text allowed"
},
{
"fkey": "7~~4",
"ftype": 7,
"fqualifier": 4,
"loc": null,
"loct": null,
"name": "Pick list, multiple choice"
},
{
"fkey": "7~~5",
"ftype": 7,
"fqualifier": 5,
"loc": null,
"loct": null,
"name": "Hyperlink"
},
{
"fkey": "7~~6",
"ftype": 7,
"fqualifier": 6,
"loc": null,
"loct": null,
"name": "Image"
},
{
"fkey": "7~~7",
"ftype": 7,
"fqualifier": 7,
"loc": null,
"loct": null,
"name": "domain"
},
{
"fkey": "7~~8",
"ftype": 7,
"fqualifier": 8,
"loc": null,
"loct": null,
"name": "Beebox path"
},
{
"fkey": "8~~1",
"ftype": 8,
"fqualifier": 1,
"loc": null,
"loct": null,
"name": "Validated"
},
{
"fkey": "8~~2",
"ftype": 8,
"fqualifier": 2,
"loc": null,
"loct": null,
"name": "Usefulness"
},
{
"fkey": "8~~12",
"ftype": 8,
"fqualifier": 12,
"loc": null,
"loct": null,
"name": "Category"
},
{
"fkey": "8~~22",
"ftype": 8,
"fqualifier": 22,
"loc": null,
"loct": null,
"name": "thu"
},
{
"fkey": "1~en~0",
"ftype": 1,
"fqualifier": 0,
"loc": "en",
"loct": "Anglais",
"name": "Anglais"
},
{
"fkey": "3~en~0",
"ftype": 3,
"fqualifier": 0,
"loc": "en",
"loct": "Anglais",
"name": "Status"
},
{
"fkey": "4~en~0",
"ftype": 4,
"fqualifier": 0,
"loc": "en",
"loct": "Anglais",
"name": "Last editor"
},
{
"fkey": "5~en~0",
"ftype": 5,
"fqualifier": 0,
"loc": "en",
"loct": "Anglais",
"name": "Locked"
},
{
"fkey": "6~en~0",
"ftype": 6,
"fqualifier": 0,
"loc": "en",
"loct": "Anglais",
"name": "Bookmark"
},
{
"fkey": "7~en~1",
"ftype": 7,
"fqualifier": 1,
"loc": "en",
"loct": "Anglais",
"name": "String"
},
{
"fkey": "7~en~2",
"ftype": 7,
"fqualifier": 2,
"loc": "en",
"loct": "Anglais",
"name": "Pick list field"
},
{
"fkey": "7~en~3",
"ftype": 7,
"fqualifier": 3,
"loc": "en",
"loct": "Anglais",
"name": "Pick list, custom text allowed"
},
{
"fkey": "7~en~4",
"ftype": 7,
"fqualifier": 4,
"loc": "en",
"loct": "Anglais",
"name": "Pick list, multiple choice"
},
{
"fkey": "7~en~5",
"ftype": 7,
"fqualifier": 5,
"loc": "en",
"loct": "Anglais",
"name": "Hyperlink"
},
{
"fkey": "7~en~6",
"ftype": 7,
"fqualifier": 6,
"loc": "en",
"loct": "Anglais",
"name": "Image"
},
{
"fkey": "7~en~7",
"ftype": 7,
"fqualifier": 7,
"loc": "en",
"loct": "Anglais",
"name": "domain"
}
],
"lasteditors": [
{
"ed": 0,
"name": ""
},
{
"ed": 1,
"name": "◀Modified by user▶"
},
{
"ed": 2,
"name": "◀Exact pre-translation▶"
},
{
"ed": 3,
"name": "◀Fuzzy pre-translation▶"
},
{
"ed": 4,
"name": "◀Partially localized▶"
},
{
"ed": 5,
"name": "◀Machine translation▶"
},
{
"ed": 6,
"name": "◀Previous version translation▶"
},
{
"ed": 7,
"name": "◀Perfect previous version translation▶"
},
{
"ed": 8,
"name": "◀Machine correction▶"
},
{
"ed": 9,
"name": "◀Perfect pre-translation▶"
}
]
}
Related content
Copyright Wordbee - Buzzin' Outside the Box since 2008