Report

Part of .vis or .dashboard

reports:   #begin of reports section (inside Vis or Dashboard)
- title: 'report title in UI'
  description: 'description in UI'
  model: model_name
  select:
  - alias.field_name
  - alias.field_name
  - ...
  sorts: alias.field_name, alias.field_name desc, ...
  timezone: 'UTC'
  limit: 500
  listen_filters:
    dashboard_filter_name: alias.field_name, alias.field_name, ...
    dashboard_filter_name: alias.field_name, alias.field_name, ...
  default_filters:
    alias.field_name:
    - 'filter expression'
    - 'filter expression'
    - ...
    alias.field_name:
    - 'filter expression'
    - 'filter expression'
    - ...
  type: chart_type
  data:
    hide_columns:
    - alias.field_name
    - alias.field_name
    - ...
    x_field: alias.field_name
    y_field: alias.field_name
    y_fields:
    - alias.field_name
    - alias.field_name
    - ...
    multi_field: alias.field_name
    value_field: alias.field_name
    previous_value_field: alias.field_name
  axis: 
    x_axis_label: 'X axis label'
    y_axis_label: 'Y axis label'
    show_x_axis_label: false
    show_y_axis_label: false
    x_axis: true
    y_axis: true
    show_axis: true
  options:
    color_scheme: 'cool'
    scheme_type: 'ordinal'
    interpolation: 'linear'
    card_color: 'rgba(255, 255, 255, 100)'
    empty_color: 'rgba(255, 255, 255, 100)'
    band_color: 'rgba(255, 255, 255, 100)'
    text_color: 'rgba(255, 255, 255, 100)'    
    units: 'usd'
    legend_title: 'Legend'
    legend: false
    labels: true
    format: true    
    show_data_label: true    
    tooltip_disabled: false
    round_edges: true
    round_domains: true
    show_grid_lines: true  
    auto_scale: false
    doughnut: false
    explode_slices: false
    gradient: false
    animations: false  
    page_size: 5
    arc_width: 0.25
    bar_padding: 8
    group_padding: 16
    inner_padding: 8
    angle_span: 240
    start_angle: -120
    big_segments: 10
    small_segments: 5
    min: 0
    max: 100
    y_scale_min: -100   
    y_scale_max: 100
    x_scale_max: 100
    format_number_data_label: '$,.0f'
    format_number_value: '$,.0f'
    format_number_axis_tick: '$,.0f'
    format_number_y_axis_tick: '$,.0f'
    format_number_x_axis_tick: '$,.0f'
  tile:
    tile_width: 8
    tile_height: 12
    tile_x: 0
    tile_y: 0

Report Parameters

Name	Type	Default	Description
title*	string	-	Report title
description	string	-	Report description in UI
model*	string	-	Model name
select*	string[]	-	List of selected fields
sorts	string	-	A way to sort data
timezone	enum	UTC	Override timezone for specific report
limit	number	500	Limit the number of rows
listen_filters	dictionary	-	(only for dashboard reports) Map dashboard filters to fields
default_filters	dictionary	-	Default filter expressions (override by listen_filters)
type*	enum	-	table bar_vertical bar_vertical_grouped bar_vertical_stacked bar_vertical_normalized bar_horizontal bar_horizontal_grouped bar_horizontal_stacked bar_horizontal_normalized pie pie_advanced pie_grid line area area_stacked area_normalized heat_map tree_map number_card gauge gauge_linear
data	dictionary	-	Data
axis	dictionary	-	Axis
options	dictionary	-	Options
tile	dictionary	-	Tile

Data

Name	Type	Default	Description
hide_columns	string[]	-	One or more of selected fields to hide table columns on visualization
x_field**	string	-	One of selected fields (dimension) to get single series data
y_field**	string	-	One of selected fields (measure or calculation) to get single series data
y_fields**	string[]	-	One or more of selected fields (measure or calculation) to get multi series data
multi_field	string	-	One of selected fields (dimension) to group multi series data
value_field**	string	-	One of selected fields (measure or calculation) to get single value
previous_value_field	string	-	One of selected fields (measure or calculation) to get single value

Axis

Name	Type	Default	Description
x_axis_label	string	x axis label	X axis label
y_axis_label	string	y axis label	Y axis label
show_x_axis_label	boolean	false	Show or hide X axis label
show_y_axis_label	boolean	false	Show or hide Y axis label
x_axis	boolean	true	Show or hide X axis
y_axis	boolean	true	Show or hide Y axis
show_axis	boolean	true	Show or hide axis

Options

Name	Type	Default	Description
color_scheme	enum	"soft"	Chart color scheme: soft vivid natural cool fire solar air aqua flame forest horizon neons picnic night night_lights
scheme_type	enum	"ordinal"	Chart scale type: ordinal linear
interpolation	enum	"linear"	Interpolation function used to generate curve: basis basis_closed bundle cardinal cardinal_closed catmull_rom catmull_rom_closed linear linear_closed monotone_x monotone_y natural step step_after step_before
card_color	string	"rgba(255, 255, 255, 100)"	Card color
empty_color	string	"rgba(255, 255, 255, 100)"	Color of empty card slots
band_color	string	"rgba(255, 255, 255, 100)"	Band color
text_color	string	-	Color of card text, defaults to inverse of card color
units	string	"Units"	Text to display under value
legend_title	string	"Legend title"	Legend title
legend	boolean	true	Show or hide legend
labels	boolean	true	Show or hide labels
format	boolean	true	Show raw or formatted values
show_data_label	boolean	true	Show or hide bar data label
tooltip_disabled	boolean	false	Show or hide tooltip
round_edges	boolean	true	Round edges
round_domains	boolean	true	Round domains for aligned grid lines
show_grid_lines	boolean	true	Show or hide grid lines
auto_scale	boolean	false	Get minimum value of Y axis from data
doughnut	boolean	false	Show doughnut instead of pie slices
explode_slices	boolean	false	Make radius of each slice proportional to it's value
gradient	boolean	false	Fill elements with a gradient instead of a solid color
animations	boolean	false	Enable animations
page_size	integer	5	Number of visible table rows
arc_width	number	0.25	Arc width, expressed as a fraction of outer radius
bar_padding	integer	8	Padding between bars in px
group_padding	integer	16	Padding between groups in px
inner_padding	integer	8	Inner padding in px
angle_span	integer	240	Angle that chart spans (in degrees)
start_angle	integer	-120	Angle that chart is rotated by. Use negative half of spanning angle to centralize
big_segments	integer	10	Number of big segments on axis
small_segments	integer	5	Number of small segments between every big segment
min	integer	0	Starting point of scale
max	integer	-	Ending point of scale
y_scale_min	number	-	Minimum value of Y axis
y_scale_max	number	-	Maximum value of Y axis
x_scale_max	number	-	Maximum value of X axis
format_number_data_label	string	-	Format Number
format_number_value	string	-	Format Number
format_number_axis_tick	string	-	Format Number
format_number_y_axis_tick	string	-	Format Number
format_number_x_axis_tick	string	-	Format Number

Tile

For dashboard only

Name	Type	Default	Description
tile_width	integer	8	Tile width (1 to 24)
tile_height	integer	12	Tile height (min is 1)
tile_x	integer	0	X coordinate of tile's top left corner on the dashboard grid (0 to 23)
tile_y	integer	0	Y coordinate of tile's top left corner on the dashboard grid (min is 0)