Skip to main content

DashboardDetail

No description

type DashboardDetail {
  publicId: String!
  name: String!
  description: String!
  filters: String!
  version: Int!
  folderId: Long
  tagIds: [Long!]!
  tiles: [DashboardTileDetail!]!
  createdBy: Long
  updatedBy: Long
  createdAt: String!
  updatedAt: String!
  settings: String!
  notes: String!
  focusId: Long!
}

Fields​

DashboardDetail.publicId ● String! non-null scalar​

DashboardDetail.name ● String! non-null scalar​

DashboardDetail.description ● String! non-null scalar​

DashboardDetail.filters ● String! non-null scalar​

JSON array of the dashboard's filters: [{id, label, type (text|number|date|date_range|multi_select), default?, values?, valuesFrom?}]. A text or multi_select filter's picker offers its static values, or with valuesFrom {source, table, column} that column's distinct values (dashboardFilterOptions).

DashboardDetail.version ● Int! non-null scalar​

Bumped on every update; updateDashboard takes it as expectedVersion and returns a conflict when it is stale.

DashboardDetail.folderId ● Long scalar​

DashboardDetail.tagIds ● [Long!]! non-null scalar​

DashboardDetail.tiles ● [DashboardTileDetail!]! non-null object​

DashboardDetail.createdBy ● Long scalar​

DashboardDetail.updatedBy ● Long scalar​

DashboardDetail.createdAt ● String! non-null scalar​

DashboardDetail.updatedAt ● String! non-null scalar​

DashboardDetail.settings ● String! non-null scalar​

JSON of the dashboard's options: {autoApplyFilters} (default true: a filter value applies as soon as it is picked or typed, instead of waiting for Apply). Changed with the set_settings op.

DashboardDetail.notes ● String! non-null scalar​

JSON array of the dashboard's notes — Markdown on the grid, not charts: [{noteId, x, y, w, h, markdown, align (left|center|right), verticalAlign (top|center|bottom), card (true: drawn on a card like a chart; false: straight on the page)}]. Changed with the set_note, move_note and remove_note ops. Markdown written by a builder: render it sanitized.

DashboardDetail.focusId ● Long! non-null scalar​

The id a Barry message names this dashboard by when it is the turn's focus (sendChatMessage focusKind dashboard, focusId).

Member Of​

DashboardMutations object ● DashboardQueries object ● DashboardUpdateResult object