Skip to content

Previewer Options

Overview

The PreviewerOptions object is used to control how the LivePreviewer loads and renders a report. Any settings defined here are to be used for report designing/debugging and have no impact on how a report is rendered outside of the Live Previewer tool.

PreviewerOptions Schema

key type required description
dataFiles string[] optional An array of URLs containing json data to be used when rendering the report. Each data file will override the one preceding it in array order. This means that if a json data element is defined in more than one file, the data in the last file loaded will win. Each URL should be proceeded with the appropriate URL prefix (e.g. 'file://' or 'gs://')
overrideData object optional An optional arbitrary json object that will be used when rendering the report. This data is loaded after all data contained in dataFiles. This provides a simple and easy way to test rendering a report with specific data changes.
resourcePaths string[] optional An array of URLs to resource files (images, options files, external components) to be used when rendering the report. Each URL can point to a folder or a ZIP file. Each URL should be proceeded with the appropriate URL prefix (e.g. 'file://' or 'gs://')