CustomDashboardDashletInput

No description

input CustomDashboardDashletInput {
  id: ID!
  dataset: String!
  fields: [String!]!
  chart: DatasetReportChart
  title: String
  filters: [DatasetFilterInput!]
  filterLogic: FilterLogic
  parameters: [DatasetParameterInput!]
  sort: CustomDashboardDashletSortInput
  limit: Int
  cumulative: Boolean
  charts: [DatasetReportChart!]
  compare: Boolean
  accent: Int
  other: Boolean
  trend: Boolean
  goal: CustomDashboardDashletGoalInput
}

Fields

CustomDashboardDashletInput.id ● ID! non-null scalar

Starts with a letter; at most 64 letters, digits, '_' or '-'. Unique within the dashboard.

CustomDashboardDashletInput.dataset ● String! non-null scalar

Dataset key, as returned by datasets.

CustomDashboardDashletInput.fields ● [String!]! non-null scalar

At least one field key. Row values come back in this order.

CustomDashboardDashletInput.chart ● DatasetReportChart enum

CustomDashboardDashletInput.title ● String scalar

CustomDashboardDashletInput.filters ● [DatasetFilterInput!] list input

CustomDashboardDashletInput.filterLogic ● FilterLogic enum

CustomDashboardDashletInput.parameters ● [DatasetParameterInput!] list input

Values for the parameters the dataset declares, as for datasetRows.

CustomDashboardDashletInput.sort ● CustomDashboardDashletSortInput input

CustomDashboardDashletInput.limit ● Int scalar

1 to 500.

CustomDashboardDashletInput.cumulative ● Boolean scalar

Draw a LINE over one date dimension as a running total, from everything before the window on. Counts only: a rate or a distinct count does not add up. Refused with a limit.

CustomDashboardDashletInput.charts ● [DatasetReportChart!] list enum

Every chart the card's toggle offers, including chart. More than one only of LINE, BAR and PIE, and never for a cumulative line. Omit for the card's own defaults.

CustomDashboardDashletInput.compare ● Boolean scalar

Compare with the previous period. Only a NUMBER, on a dataset the window applies to; refused anywhere else.

CustomDashboardDashletInput.accent ● Int scalar

The palette slot, 1 to 8, to draw a chart of one series in: a LINE or BAR of one metric over at most one grouping. Omit for the first.

CustomDashboardDashletInput.other ● Boolean scalar

Draw everything past the top N as one grey "Other". Needs a limit of at most 7, one grouping that is not a date, a BAR or PIE, and metrics that add up (counts and sums, never a unique count or a rate).

CustomDashboardDashletInput.trend ● Boolean scalar

A NUMBER draws a trend line under its figure: its metric by day, week or month as the window's length decides. Only on a dataset with a date.

CustomDashboardDashletInput.goal ● CustomDashboardDashletGoalInput input

A GOAL's target and period; refused on any other chart.

Member Of

CustomDashboardDefinitionInput input ● saveCustomDashboardLayout mutation