Dashboards: QBL v0.15

  • 2 minute(s) read
Prev Next

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. 

Dashboard

Property

Required

Default

Allowed Values

Name

False

""

Any string

Dashboard filter

Property

Required

Default

Allowed Values

Name

False

""

Any string

FilterType

True

-

One of: Text, User, UserList, 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: Field (Scope: solution)
See nested properties

        FieldId

True

-

Any string

    Report

True

-

References: Report (Scope: solution), Chart (Scope: solution)
See nested properties

        TableId

True

-

Any string

        QueryId

True

-

Any string

    IsActive

False

True

true or false

Dashboard tab

Property

Required

Default

Allowed Values

Name

False

""

Any string

CanvasVersion

True

-

Any integer

Dashboard widget

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Dashboard widget button

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Text

False

""

Any string

Color

False

""

Any string

Icon

False

""

Any string

Alignment

True

-

One of: Left, Center, Right

OpenInNewWindow

True

-

true or false

Dashboard widget button: CreateRecord

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Text

False

""

Any string

Color

False

""

Any string

Icon

False

""

Any string

Alignment

True

-

One of: Left, Center, Right

OpenInNewWindow

True

-

true or false

AfterSaveAction

True

-

One of: ReturnToDashboard, ViewNewRecord, GoToPage, GoToReport

AfterSaveGoTo

False

""

References: QB::Dashboard (Scope: solution), Report (Scope: solution), Chart (Scope: solution)
Any string
Any integer
See nested properties

    App

False

""

References: QB::Application (Scope: solution)
Any string

    NonDashboardPageId

False

0

Any integer

    AppId

True

-

Any string

    DashboardId

True

-

Any string

    TableId

True

-

Any string

    QueryId

True

-

Any string

Table

False

""

References: QB::Table (Scope: solution)
Any string
See nested properties

    AppId

False

""

Any string

    TableId

True

-

Any string

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Text

False

""

Any string

Color

False

""

Any string

Icon

False

""

Any string

Alignment

True

-

One of: Left, Center, Right

OpenInNewWindow

True

-

true or false

Link

False

""

Any string

Dashboard widget button: OpenPage

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Text

False

""

Any string

Color

False

""

Any string

Icon

False

""

Any string

Alignment

True

-

One of: Left, Center, Right

OpenInNewWindow

True

-

true or false

Page

False

""

References: QB::Dashboard (Scope: solution)
Any string
See nested properties

    NonDashboardPageId

False

0

Any integer

    App

False

""

References: App (Scope: solution)
Any string

    AppId

False

""

Any string

    DashboardId

False

""

Any string

Dashboard widget button: OpenReport

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Text

False

""

Any string

Color

False

""

Any string

Icon

False

""

Any string

Alignment

True

-

One of: Left, Center, Right

OpenInNewWindow

True

-

true or false

Report

False

""

References: Report (Scope: solution), Chart (Scope: solution)
Any string
See nested properties

    AppId

True

-

Any string

    TableId

True

-

Any string

    QueryId

True

-

Any string

Dashboard widget calendar

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

ShowTitle

False

False

true or false

DefaultView

True

-

One of: Day, Week, Month

ShowWeekends

False

True

true or false

Report

True

-

References: QB::Report::Calendar (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ReportId

True

-

Any string

Dashboard widget chart

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

Report

True

-

References: Chart (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ChartId

True

-

Any string

Dashboard widget kanban

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

ShowTitle

False

False

true or false

Report

True

-

References: QB::Report::Kanban (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ReportId

True

-

Any string

Dashboard widget KPI

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

Description

False

""

Any string

KpiType

True

-

One of: Text, Gauge

IncludesDelta

False

False

true or false

ShowTitle

False

False

true or false

ShowTarget

False

True

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

-

See nested properties

    Period

True

-

One of: Day, Week, Month, Quarter, Year

    Field

True

-

References: Field (Scope: named_scope)
See nested properties

        FieldId

True

-

Any string

Report

True

-

References: Chart (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ChartId

True

-

Any string

Dashboard widget map

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

ShowTitle

False

False

true or false

Report

True

-

References: QB::Report::Map (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ReportId

True

-

Any string

Dashboard widget rich text

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Content

False

""

Any string

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

SearchType

True

-

One of: PartialMatches, ExactMatch, UserChosen

ResultsView

True

-

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

-

Any string

SearchTarget

True

-

One of: AllSearchableFields, ChosenFields, Report

SearchTable

False

""

References: QB::Table (Scope: solution)
Any string
See nested properties

    AppId

False

""

Any string

    TableId

True

-

Any string

SearchReport

False

""

References: Report (Scope: solution), Chart (Scope: solution)
Any string
See nested properties

    AppId

True

-

Any string

    TableId

True

-

Any string

    QueryId

True

-

Any string

SearchFields

False

-

See nested properties

    SearchBoxStyle

True

-

One of: AllFields, SingleField

    Table

False

""

References: QB::Table (Scope: solution)
Any string
See nested properties

        AppId

False

""

Any string

        TableId

True

-

Any string

    Fields

False

[]

Array of items of type: Any string

Dashboard widget spacer

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

DividerType

True

-

One of: Horizontal, Vertical, None

Dashboard widget summary

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

ShowTitle

False

False

true or false

Report

True

-

References: QB::Report::Summary (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ReportId

True

-

Any string

Dashboard widget table

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

ShowTitle

False

False

true or false

Title

False

""

Any string

Report

True

-

References: QB::Report::Table (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ReportId

True

-

Any string

DisableSpreadsheetEdit

False

False

true or false

Dashboard widget timeline

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

ShowTitle

False

False

true or false

Report

True

-

References: QB::Report::Timeline (Scope: solution)
See nested properties

    TableId

True

-

Any string

    ReportId

True

-

Any string

Dashboard widget webpage

Property

Required

Default

Allowed Values

X

True

-

Any integer

Y

True

-

Any integer

Width

True

-

Any integer

Height

True

-

Any integer

Title

False

""

Any string

ShowTitle

False

False

true or false

ShowBorder

False

False

true or false

Url

False

""

Any string