Documentation Index

Fetch the complete documentation index at: https://help.quickbase.com/llms.txt

Use this file to discover all available pages before exploring further.

Dashboards: QBL v0.14

  • 3 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 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: Field (Scope: solution). See nested properties.

        FieldId

True

Any string. References: Field (Scope: solution)

    Report

True

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

        TableId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

        QueryId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

    IsActive

False

True

true or false

Dashboard tab

Property Name

Required

Default

Allowed Values

Name

False

""

Any string

CanvasVersion

True

Any integer

Dashboard widget

Property Name

Required

Default

Allowed Values

X

True

Any integer

Y

True

Any integer

Width

True

Any integer

Height

True

Any integer

Dashboard widget button

Property Name

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 Name

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). See nested properties.

    App

False

""

References: QB::Application (Scope: solution)

    NonDashboardPageId

False

0

Any integer. References: QB::Dashboard (Scope: solution), Report (Scope: solution), Chart (Scope: solution)

    AppId

True

Any string. References: QB::Dashboard (Scope: solution), Report (Scope: solution), Chart (Scope: solution)

    DashboardId

True

Any string. References: QB::Dashboard (Scope: solution), Report (Scope: solution), Chart (Scope: solution)

    TableId

True

Any string. References: QB::Dashboard (Scope: solution), Report (Scope: solution), Chart (Scope: solution)

    QueryId

True

Any string. References: QB::Dashboard (Scope: solution), Report (Scope: solution), Chart (Scope: solution)

Table

False

""

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

    AppId

True

Any string. References: QB::Table (Scope: solution)

    TableId

True

Any string. References: QB::Table (Scope: solution)

Property Name

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 Name

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). See nested properties.

    NonDashboardPageId

False

0

Any integer. References: QB::Dashboard (Scope: solution)

    App

False

""

References: App (Scope: solution)

    AppId

False

""

Any string. References: QB::Dashboard (Scope: solution)

    DashboardId

False

""

Any string. References: QB::Dashboard (Scope: solution)

Dashboard widget button: OpenReport

Property Name

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). See nested properties.

    AppId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

    TableId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

    QueryId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

Dashboard widget calendar

Property Name

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. References: QB::Report::Calendar (Scope: solution)

    ReportId

True

Any string. References: QB::Report::Calendar (Scope: solution)

Dashboard widget chart

Property Name

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. References: Chart (Scope: solution)

    ChartId

True

Any string. References: Chart (Scope: solution)

Dashboard widget kanban

Property Name

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. References: QB::Report::Kanban (Scope: solution)

    ReportId

True

Any string. References: QB::Report::Kanban (Scope: solution)

Dashboard widget KPI

Property Name

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. References: Field (Scope: named_scope)

Report

True

References: Chart (Scope: solution). See nested properties.

    TableId

True

Any string. References: Chart (Scope: solution)

    ChartId

True

Any string. References: Chart (Scope: solution)

Dashboard widget map

Property Name

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. References: QB::Report::Map (Scope: solution)

    ReportId

True

Any string. References: QB::Report::Map (Scope: solution)

Dashboard widget rich text

Property Name

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 Name

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). See nested properties.

    AppId

True

Any string. References: QB::Table (Scope: solution)

    TableId

True

Any string. References: QB::Table (Scope: solution)

SearchReport

False

""

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

    AppId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

    TableId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

    QueryId

True

Any string. References: Report (Scope: solution), Chart (Scope: solution)

SearchFields

False

See nested properties

    SearchBoxStyle

True

One of: AllFields, SingleField

    Table

False

""

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

        AppId

True

Any string. References: QB::Table (Scope: solution)

        TableId

True

Any string. References: QB::Table (Scope: solution)

    Fields

False

[]

Array of items of type: / Any string

Dashboard widget spacer

Property Name

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 Name

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. References: QB::Report::Summary (Scope: solution)

    ReportId

True

Any string. References: QB::Report::Summary (Scope: solution)

Dashboard widget table

Property Name

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. References: QB::Report::Table (Scope: solution)

    ReportId

True

Any string. References: QB::Report::Table (Scope: solution)

DisableSpreadsheetEdit

False

False

true or false

Dashboard widget timeline

Property Name

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. References: QB::Report::Timeline (Scope: solution)

    ReportId

True

Any string. References: QB::Report::Timeline (Scope: solution)

Dashboard widget webpage

Property Name

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