Dashboards: QBL v0.11 – Quickbase Help

This article contains information about a QBL (Quickbase language) object. QBL objects are the supported Quickbase schema elements you see textually represented in the YAML file generated by Quickbase when you export a solution. Each object has associated properties. Supported schema may differ by QBL version.

The following table lists information about the properties of this object.

In this article

Dashboard
Dashboard filter
Dashboard tab
Dashboard widget
Dashboard widget button
Dashboard widget button: CreateRecord
Dashboard widget button: OpenLink
Dashboard widget button: OpenPage
Dashboard widget button: OpenReport
Dashboard widget calendar
Dashboard widget chart
Dashboard widget kanban
Dashboard widget KPI
Dashboard widget map
Dashboard widget rich text
Dashboard widget search
Dashboard widget spacer
Dashboard widget summary
Dashboard widget table
Dashboard widget timeline

Dashboard

Property Name	Required	Default	Allowed Values
Name	False	""	Any string

Dashboard filter

Property Name	Required	Default	Allowed Values
Name	False	""	Any string
FilterType	True		One of: Text, User, Date
Description	False	""	Any string
SearchType	False	PartialMatches	One of: PartialMatches, ExactMatch, UserChosen
Targets	False	[]	Array of items of type: See nested properties
CompareField	True	References: 1. Field - Scope: solution
Report	True	References: 1. Report - Scope: solution, 2. Chart - Scope: solution
IsActive	False	true or false

Dashboard tab

Property Name	Required	Default	Allowed Values
Name	False	""	Any string
CanvasVersion	True	None	Any integer

Dashboard widget

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer

Dashboard widget button

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Text	False	""	Any string
Color	False	""	Any string
Icon	False	""	Any string
Alignment	True	None	One of: Left, Center, Right
OpenInNewWindow	True	None	true or false

Dashboard widget button: CreateRecord

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Text	False	""	Any string
Color	False	""	Any string
Icon	False	""	Any string
Alignment	True	None	One of: Left, Center, Right
OpenInNewWindow	True	None	true or false
AfterSaveAction	True	None	One of: ReturnToDashboard, ViewNewRecord, GoToPage, GoToReport
AfterSaveGoTo	False	""	References: QB::Dashboard, Report, Chart Scope: solution
App	False	""	References: QB::Application, Dashboard, Report, Chart Scope: solution Any string
NonDashboardPageId	False	0	Any integer References: QB::Dashboard, Report, Chart Scope: solution
Table	False	""	References: QB::Table Scope: solution Any string

Dashboard widget button: OpenLink

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Text	False	""	Any string
Color	False	""	Any string
Icon	False	""	Any string
Alignment	True	None	One of: Left, Center, Right
OpenInNewWindow	True	None	true or false
Link	False	""	Any string

Dashboard widget button: OpenPage

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Text	False	""	Any string
Color	False	""	Any string
Icon	False	""	Any string
Alignment	True	None	One of: Left, Center, Right
OpenInNewWindow	True	None	true or false
Page	False	""	References: QB::Dashboard Scope: solution
NonDashboardPageId	False	0	Any integer References: QB::Dashboard Scope: solution
App	False	""	Any string References: App, QB::Dashboard Scope: solution

Dashboard widget button: OpenReport

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Text	False	""	Any string
Color	False	""	Any string
Icon	False	""	Any string
Alignment	True	None	One of: Left, Center, Right
OpenInNewWindow	True	None	true or false
Report	False	""	Any string

Dashboard widget calendar

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Title	False	""	Any string
ShowTitle	False	False	true or false
DefaultView	True	None	One of: Day, Week, Month
ShowWeekends	False	True	true or false
Report	True	None	References: QB::Report::Calendar Scope: solution

Dashboard widget chart

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Title	False	""	Any string
Report	True	None	References: Chart Scope: solution

Dashboard widget kanban

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Title	False	""	Any string
ShowTitle	False	False	true or false
Report	True	None	References: QB::Report::Kanban Scope: solution

Dashboard widget KPI

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Title	False	""	Any string
Description	False	""	Any string
KpiType	True	None	One of: Text, Gauge
IncludesDelta	False	False	true or false
ShowTitle	False	False	true or false
ShowTarget	False	False	true or false
Scale	False	Auto	One of: Auto, Ones, Thousands, Millions, Billions
DecimalPlaces	False	1	Any integer
TextColor	False	Dynamic	One of: Dynamic, Black, White
DeltaOptions	False	None	See nested values
Period	True		One of: Day, Week, Month, Quarter, Year
Field	True
Report	True	None	References: Chart Scope: solution

Dashboard widget map

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Title	False	""	Any string
ShowTitle	False	False	true or false
Report	True	None	References: QB::Report::Map Scope: solution

Dashboard widget rich text

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Content	False	""	Any string

Dashboard widget search

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
SearchType	True	None	One of: PartialMatches, ExactMatch, UserChosen
ResultsView	True	None	One of: PopupWindow, NewWindow
ShowTitle	False	False	true or false
ShowHintText	False	False	true or false
Title	False	""	Any string
HintText	False	""	Any string
BackgroundColor	True	None	Any string
SearchTarget	True	None	One of: AllSearchableFields, ChosenFields, Report
SearchTable	False	""	References: QB::Table Scope: solution Any string
SearchReport	False	""	References: Report, Chart Scope: solution Any string
SearchFields	False	None	See nested values
SearchBoxStyle	True		One of: AllFields, SingleField
Table	False	""	References: QB::Table Scope: solution Any string
Fields	False	[]	Array of items of type: Reference to Field

Dashboard widget spacer

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
DividerType	True	None	One of: Horizontal, Vertical, None

Dashboard widget summary

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Title	False	""	Any string
ShowTitle	False	False	true or false
Report	True	None	References: QB::Report::Summary Scope: solution

Dashboard widget table

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
ShowTitle	False	False	true or false
Title	False	""	Any string
Report	True	None	References: QB::Report::Table Scope: solution

Dashboard widget timeline

Property Name	Required	Default	Allowed Values
X	True	None	Any integer
Y	True	None	Any integer
Width	True	None	Any integer
Height	True	None	Any integer
Title	False	""	Any string
ShowTitle	False	False	true or false
Report	True	None	References: QB::Report::Timeline Scope: solution