saveCustomDashboardLayout
Save from the dashboard editor, by hand or by autosave, in one call: the layout and the row modes, and the dashlets when given (every dashlet, replacing the ones the dashboard had), the window and comparison, name and description when given, and the URL filters when given. Applied to the version the page shows.
An unsaved dashboard keeps one revision, its draft, updated in place: an autosave leaves it unsaved, and a Save (autosave false) publishes it, which keeps it. A saved dashboard publishes; one person's editing session is one version, updated in place while they keep saving (another person, ten idle minutes, a restore or an explicit Save starts the next), the previous version kept as history.
saveCustomDashboardLayout(
id: ID!
layout: [CustomDashboardLayoutSlotInput!]!
rows: [CustomDashboardRowInput!]!
dashlets: [CustomDashboardDashletInput!]
content: [CustomDashboardContentInput!]
window: CustomDashboardWindowInput
compare: DatasetCompare
name: String
description: String
filters: [CustomDashboardFilterInput!]
autosave: Boolean = false
compile: CustomDashboardCompileSettingsInput
colors: [CustomDashboardColorInput!]
last_updated_at_for_locking: DateTime
): CustomDashboard!
Arguments
saveCustomDashboardLayout.id ● ID! non-null scalar
saveCustomDashboardLayout.layout ● [CustomDashboardLayoutSlotInput!]! non-null input
saveCustomDashboardLayout.rows ● [CustomDashboardRowInput!]! non-null input
saveCustomDashboardLayout.dashlets ● [CustomDashboardDashletInput!] list input
Every dashlet the dashboard keeps, each as the editor left it. Left out, the dashlets stay as they are.
saveCustomDashboardLayout.content ● [CustomDashboardContentInput!] list input
Every SECTION and TEXT card the dashboard keeps, replacing the ones it had. Left out, they stay as they are.
saveCustomDashboardLayout.window ● CustomDashboardWindowInput input
The date range the dashboard opens on. Left out, it stays as it is.
saveCustomDashboardLayout.compare ● DatasetCompare enum
What the dashboard compares to. Left out, it stays as it is.
saveCustomDashboardLayout.name ● String scalar
The dashboard's name. Left out or blank, it stays as it is.
saveCustomDashboardLayout.description ● String scalar
Its description; empty or null for none. Left out, it stays as it is.
saveCustomDashboardLayout.filters ● [CustomDashboardFilterInput!] list input
Every URL filter the dashboard keeps, replacing the ones it had: the editor drops one no dashlet it keeps can take. Left out, they stay as they are.
saveCustomDashboardLayout.autosave ● Boolean scalar
Written by autosave rather than Save: an unsaved dashboard stays unsaved, and the editing session stays open.
saveCustomDashboardLayout.compile ● CustomDashboardCompileSettingsInput input
Live or compiled, and the compile settings. Left out, they stay as they are.
saveCustomDashboardLayout.colors ● [CustomDashboardColorInput!] list input
Every locked series colour the dashboard keeps, replacing the ones it had. Left out, they stay as they are.
saveCustomDashboardLayout.last_updated_at_for_locking ● DateTime scalar
The dashboard's updated_at as the editor last read it. When another user has saved the dashboard since, the save is refused. Left out, nothing is checked.
