OBJECT

DashboardGrid

link GraphQL Schema definition

  • type DashboardGrid {
  • # Filter conditions limiting which records are listed in the grid.
  • gridFilter: FieldFilter!
  • # Record type listed in the grid (e.g. Opportunity, Lead, Account).
  • gridSourceEntity: EntityNameEnum!
  • # API name of the source record type when it is a custom entity; null for built-in
  • # entities.
  • gridSourceEntityApiName: String
  • # Ordered columns shown in the grid, each identifying a field and its display
  • # options.
  • gridColumns: [GridColumnsOutput!]!
  • # Identifier of the field the grid rows are sorted by.
  • gridSortBy: ID!
  • # Sort direction applied to gridSortBy: Asc or Desc.
  • gridSortOrder: SortOrder!
  • # When true, a totals row is shown summarizing the grid columns.
  • gridShowTotal: Boolean!
  • # When true, the grid is limited to the first gridTopRecords rows.
  • gridShowTopRecordsOnly: Boolean!
  • # Maximum number of rows shown when gridShowTopRecordsOnly is true.
  • gridTopRecords: Int
  • }