Skip to main content

export

Parameter​

An object with the following keys:

KeyTypeDesctription
optionsobjectAn object with options that affect how items are exported.
countersarray of stringsAn array of names of counters to export.
variablesarray of stringsAn array of names of variables to export.
shiftcodesarray of stringsAn array of names of shift codes to export.
clocksarray of stringsAn array of names of clocks to export.
timeformatsarray of stringsAn array of names of time formats to export.
numberFormatsarray of stringsAn array of names of number formats to export.
tablesarray of stringsAn array of names of tables to export.
fontsarray of stringsAn array of names of font files to export.
imagesarray of stringsAn array of names of images to export.
labelsarray of stringsAn array of names of labels to export.

The options object has the following keys:

KeyTypeDesctription
includeImagesbooleanIf true, include any images that are used by the labels selected in the export. Default false.
includeFontsbooleanIf true, include any fonts that are used by the labels selected in the export. Default false.
includeDynamicTextbooleanIf true, include the dynamic text resources (counters, variables, shift codes, time formats, clocks and number formats) used by the labels selected in the export. Built-in time formats and number formats are left out. Clocks and number formats are included v6.1. Default false.

Return value​

An object with the same keys as the parameter (only those with exported items are present). Each value contains the exported items, in a form suitable for passing to import.

The object also contains an _app_version key with the software version that made the export v5.0.3. The key is ignored by import. When a file exported from a newer software version is imported in the web UI, it is imported with a warning.