QuillReport
TheQuillReport interface represents a single item on a dashboard (a chart, metric tile, table, etc.).
string
required
The report’s unique id.
string
required
The name of the report.
string
required
The name of the dashboard this report belongs to.
{ [key: string]: string }[]
required
The rows of data returned from this report’s query.
Column[]
required
The columns data returned from this report’s query.
string
required
The chart type rendered for this report (e.g.
"line", "pie", "table", "bar", "column", "metric").boolean
Whether to show a legend for this chart.
{ table: string; field: string }
The table and field this report uses for date filtering, if any.
Pivot | null
required
The pivot used in this query, if any.
string
required
The label of the xAxis.
string
required
The field used for this report’s xAxis.
AxisFormat
required
The format used for this report’s xAxis.
boolean
Whether this report is a template.
{ field: string; label: string; format: AxisFormat }[]
required
Metadata about each yAxis on this report.
number
required
The relative ordering of this report among its siblings. Ordering starts at
- Reports in the same section are first grouped by
chartType, then sorted byorderwithin each group.
{ [key: string]: string }[]
required
The rows of data for the comparison date range, when the report supports
comparison.
InternalFilter[]
The filters currently applied to this report’s query.
Pagination
Pagination state for table reports.
{ field: string; direction: string }
Sort state for table reports.
number
required
Total row count used for SQL pagination.
string
required
The query that produced this report, used by the report builder on initial
load.
{ [key: string]: { table: string; field: string } }
A map of dashboard filters to the table/field they apply to for this report.
{ label: string; query: [number, number] | string }[]
Reference lines to render on compatible charts.
{ label: string; query: [number, number] }[]
Resolved reference line y values.
boolean
Whether to automatically display custom fields.
Column[]
Columns that include custom fields.
{ [key: string]: string }[]
The pivot row data, when the report has a pivot.
ColumnInternal[]
Metadata about the pivot yAxes.
number
The total pivot row count.