Skip to main content
Version: 9.2

Dashboard Customization

The Customization Object

Every widget defines its own structure and allows this structure to be configured with a customization object. This enables fine-grained control over the visibility and behavior of UI components in the Dashboard widget. It allows teams to tailor the interface based on user roles, product branding, or embedding context.

This is a recursive module, so you can add keep and remove at the top level or within a view.

// The customization object
{
remove: [ ... ], // Optional. Global elements to remove.
keep: [ ... ], // Optional. Global elements to retain.
views: { // Supports the following:
list: { ... }, // The Asset List
design: { ... }, // The Dashboard Editor
preview: { ... }, // Preview mode of a Dashboard
endUser: { ... } // Live, interactive end-user dashboard
}
}

Within each view, you can include the following:

KeyTypeDescription
removestring[]List of UI controls to hide.
keepstring[]List of UI controls to retain (others at the same level will be removed).
defaultsobjectDefault settings for specific functionality.
subModulesobjectCustomizations for dependent components (e.g., chart panels, modals).
subModules.conditionalarrayList of rule-based customizations based on attributes (only for subModules).

The global verbs, keep and remove, are evaluated in order of precedence:

  1. remove: Removes matching keys.
  2. keep: Keeps matching keys while removing all others at the same level.

To simplify configuration, wildcards can be used:

PatternBehavior
*stringMatches anything ending with string.
string*Matches anything starting with string.
*string*Matches anything containing string.

Please Note:

  • For the keep definition, if a key matches the pattern, it will be the only item on its level to remain in the structure.
  • remove is a placeholder to signal that a control is not available in embed mode or should never be shown to users.
  • You may configure customization dynamically at runtime based on user roles or application state.
  • The grammar is extendable and supports overrides for dependent widgets using subModules.

Full Example

const customization = {
// Global elements to remove
remove: ['navBar.appTitle'], // Remove the application title from the navigation bar

views: {
// List View Customization
list: {
remove: [
'controlBarLeft.qCreateDash', // Remove "Create" button
'controlBarRight.qSwitchView', // Remove "Switch View" option
'assetList.asset.optionMenu.qEditDash' // Remove "Edit" action
'assetList.asset.optionMenu.qUseDash' // Remove "Use" action
'assetList.asset.optionMenu.qDeleteDash', // Remove "Delete" action
'assetList.asset.optionMenu.qDuplDash', // Remove "Duplicate" action
],
defaults: {
assetListViewMode: 'table' // Set "Table" as default view
}
},

// Design View Customization
design: {
remove: [
'menuBar.file.qMnuCreateDash', // Remove "New" option
'menuBar.file.qMnuDuplicateDash', // Remove "Duplicate" option
'menuBar.file.qMnuDeleteDash', // Remove "Delete" option
'*Themes' // Remove all theme-related options
],
keep: [
'*DownloadDash.qDashPDF' // Keep only "Download PDF" in download menu
],
subModules: {
chartPanel: {
keep: ['header.optionMenu.qDownloadChart.qChartPDF'], // Keep "Download PDF" in chart panel
remove: ['header.qChartSelection'] // Remove "Chart Selection" option
}
}
},

// Preview View Customization
preview: {
remove: ['filterPanel'], // Remove filter panel
subModules: {
chartPanel: {
keep: ['header.qChartName'] // Keep only chart name
}
}
},

// End-User View Customization
endUser: {
subModules: {
chartPanel: {
conditional: [
{
condition: {
field: 'category',
operator: '=',
value: 'metric'
},
keep: ['header.optionMenu.qDownloadChart.qChartPDF'] // Keep "Download PDF" only for metrics
}
]
}
}
}
}
};

The views Parameters

ViewKeyDescription
designcontrolBarRight.qDiscardThe button for discarding changes.
designcontrolBarRight.qPreviewAllows the preview mode visualization.
designcontrolBarRight.qPublishThe button for publishing a new version of the dashboard.
designcontrolBarRight.qStatusThe status label for the dashboard.
designcontrolBarRight.qSwitchModeThe option to switch between Design and Interaction mode. Only available when a dashboard is published.
designdownloadModalThe options associated with the download modal.
designdownloadModal.qScheduleOptionThe schedule button inside the download modal.
designdownloadModal.qSubscribeExternalUsersThe option to add external users using the Enter key within the Subscribe tab.
designdownloadModal.qSubscribeOptionThe Subscribe tab within the Download modal.
designfilterPanelThe filters panel.
designfilterPanel.qAddFilterThe add button for the filter panel.
designmenuBar.file.qMnuCanvasSizeThe canvas size option inside the file menu. Only available if the canvas mode is Fixed.
designmenuBar.file.qMnuCreateDashThe new dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
designmenuBar.file.qMnuDeleteDashThe delete dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
designmenuBar.file.qMnuDownloadDashDownload options for the dashboard.
designmenuBar.file.qMnuDownloadDash.qDashCSVCSV download option.
designmenuBar.file.qMnuDownloadDash.qDashExcelExcel download option.
designmenuBar.file.qMnuDownloadDash.qDashPDFPDF download option.
designmenuBar.file.qMnuDownloadDash.qDashDatasetDataset download option.
designmenuBar.file.qCreateDatasetThe custom dataset options inside file menu.
designmenuBar.file.qCreateDataset.qCreateCustomDatasetThe create custom dataset option inside the file menu.
designmenuBar.file.qCreateDataset.qViewCustomDatasetThe view custom datasets option inside the file menu.
designmenuBar.file.qMnuDuplicateDashThe duplicate dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
designmenuBar.file.qMnuOpenDashThe open dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
designmenuBar.gridThe grid menu.
designmenuBar.insert.qMnuInsertChartThe insert chart group inside the insert menu.
designmenuBar.insert.qMnuInsertChart.qMnuExistingChartThe option for inserting existing chart from the gallery for the insert menu.
designmenuBar.insert.qMnuInsertChart.qMnuNewChartThe option for inserting a new chart from the chart builder for the insert menu.
designnavBarThe main top bar.
designnavBar.qBackButtonThe back button on the nav bar. Only available when a dashboard is selected.
designtoolBar.gridThe grid group inside the toolbar.
designtoolBar.qCanvasSizeThe canvas size option inside the toolbar.
designtoolBar.qDownloadDashDownload options for the dashboard.
designtoolBar.qDownloadDash.qDashCSVCSV download option.
designtoolBar.qDownloadDash.qDashExcelExcel download option.
designtoolBar.qDownloadDash.qDashPDFPDF download option.
designtoolBar.qDownloadDash.qDashDatasetDataset download option.
designtoolBar.qCreateDatasetCustom Dataset options.
designtoolBar.qCreateDataset.qCreateCustomDatasetThe option to create a new Custom Dataset.
designtoolBar.qCreateDataset.qViewCustomDatasetThe option to view Custom Datasets.
designtoolBar.qInsertChartThe insert chart group inside the toolbar.
designtoolBar.qInsertChart.qExistingChartThe option for inserting existing chart from the gallery for the toolbar.
designtoolBar.qInsertChart.qNewChartThe option for inserting a new chart from the chart builder for the toolbar.
designtoolBar.qResponsiveViewThe responsive view group in the toolbar.
endUserdownloadModalThe options associated with the download modal.
endUserdownloadModal.qScheduleOptionThe schedule button inside the download modal.
endUserfilterPanelThe filters panel.
endUserfilterPanel.qAddFilterThe add button for the filter panel.
endUsernavBarThe main top bar.
endUsernavBar.qBackButtonThe back button on the nav bar. Only available when a dashboard is selected.
endUsertoolBar.qSwitchModeThe option to switch between Design and Interaction mode. Only available when a dashboard is published.
listassetList.asset.optionMenu.qEditDashThe edit option inside the menu for the list.
listassetList.asset.optionMenu.qUseDashThe use option inside the menu for the list. Only visisble when a dashboard is published.
listassetList.asset.optionMenu.qDeleteDashThe delete option inside the menu for the list.
listcontrolBarLeft.qCreateDashThe create button for the asset list.
listnavBarThe main top bar.
previewcontrolBarRightThe list of options on the right side of the control bar.
previewfilterPanelThe filters panel.
previewfilterPanel.qAddFilterThe add button for the filter panel.
previewnavBarThe main top bar.
previewnavBar.qBackButtonThe back button on the nav bar.

Defaults

Enables you to set styles and other customizations for the dependent components.

defaults: {
customStyles:{
button: { 'color': '#200606' }
}
}

The following options are available for fontFamily properties.

  • 'Inter, serif'
  • 'Roboto, sans-serif'
  • 'Georgia, serif'
  • 'Palatino Linotype, Book Antiqua, Palatino, serif'
  • 'Times New Roman, Times, serif'
  • 'Arial, Helvetica, sans-serif'
  • 'Arial Black, Gadget, sans-serif'
  • 'Comic Sans MS, cursive, sans-serif'
  • 'Impact, Charcoal, sans-serif'
  • 'Lucida Sans Unicode, Lucida Grande, sans-serif'
  • 'Tahoma, Geneva, sans-serif'
  • 'Trebuchet MS, Helvetica, sans-serif'
  • 'Verdana, Geneva, sans-serif'
  • 'Courier New, Courier, monospace'
  • 'Lucida Console, Monaco, monospace'

The following options are available for defaultValidator and validators properties.

  • EQUALS
  • NOT_EQUAL
  • CONTAINS
  • NOT_CONTAIN
  • ENDS_WITH
  • NOT_END_WITH
  • STARTS_WITH
  • NOT_START_WITH
  • BETWEEN_INCLUSIVE
  • BETWEEN_EXCLUSIVE
  • LESS_THAN
  • LESS_THAN_EQUAL
  • GREATER_THAN
  • GREATER_THAN_EQUAL
  • IS_NULL
  • IS_NOT_NULL
  • BEFORE
  • AFTER
  • BEFORE_ON
  • AFTER_ON
  • IN
ViewPropertyTypeDescriptionExample
listassetListViewModestringDefines the default view mode for the asset list."card" or "table"
---For Text Items-----------
designcustomStyles.text.alignTextstringDefault align text for the text element."left", "center", "right", or "justify"
designcustomStyles.text.backgroundColorstringDefault background color.Examples: '#000000', 'green', 'GREEN'
designcustomStyles.text.borderColorstringDefault border color for the text element.Example: '#000000', 'green', 'GREEN'
designcustomStyles.text.borderStylestringDefault border Style"solid", "dotted", "dashed", or "double"
designcustomStyles.text.borderWidthstringDefault border widthAny value between "1px" to "20px"
designcustomStyles.text.fontColorstringDefault font color for the text elementExample: '#000000', 'green', 'GREEN'
designcustomStyles.text.fontFamilystringDefault font for the text elementEx: 'Lucida Console, Monaco, monospace'
designcustomStyles.text.fontSizestringDefault font size for the text elementChoose from: 8, 9, 10, 11, 12, 14, 15, 16, 18, 24, 30, 36, 48, 60, 72, or "96px"
designcustomStyles.text.fontStylebooleanDefault font style for the text element (italic styling)true
designcustomStyles.text.fontWeightbooleanDefault font weight for the text element (bold styling)true
designcustomStyles.text.paddingBottomnumberDefault padding bottom for the text element"20px"
designcustomStyles.text.paddingLeftnumberDefault padding left for the text element"20px"
designcustomStyles.text.paddingRightnumberDefault padding right for the text element"20px"
designcustomStyles.text.paddingTopnumberDefault padding top for the text element"20px"
designcustomStyles.text.strikebooleanDefault strike for the text elementtrue
designcustomStyles.text.underlinebooleanDefault underline for the text elementtrue
---For Image Items---------
designcustomStyles.image.aspectstringDefault aspect for image"contain", "cover", or "fill"
---For Button Items---------
designcustomStyles.button.backgroundstringbutton background colorExamples: '#000000', 'green', 'GREEN'
designcustomStyles.button.colorstringbutton font colorExamples: '#000000', 'green', 'GREEN'
designcustomStyles.button.fontFamilystringbutton fontFamily'Lucida Console, Monaco, monospace'
designcustomStyles.button.fontSizestringbutton font sizeChoose from 8, 9, 10, 11, 12, 14, 15, 16, 18, 24, 30, 36, 48, 60, 72, or "96px"
designcustomStyles.button.labelstringtext for the element"Any cool text you want"
designcustomStyles.button.urlstringurl for the button click event"www.any-cool-url.con"
---For Header Items---------
designcustomStyles.header.layoutWidthstringwidth of the header"screen" or "canvas"
designcustomStyles.header.backgroundColorstringBackground color for the headerExamples: '#000000', 'green', 'GREEN'
designcustomStyles.header.heightstringDefault header size.Value should be between 10 and 300.
designcustomStyles.header.backgroundImageConfig.aspectstringDefault aspect for header background image"contain", "cover" or "fill"
designcustomStyles.header.backgroundImageConfig.imagestringBackground image for the header."www.any-cool-url.con"
---For Tabs Items---------
designcustomStyles.tab.backgroundColorstringTabs indicator colorExamples: '#000000', 'green', 'GREEN'
designcustomStyles.tab.borderstringTabs' border colorExamples: '#000000', 'green', 'GREEN'
designcustomStyles.tab.fontColorstringTabs font colorExamples: '#000000', 'green', 'GREEN'
designcustomStyles.tab.fontSizestringTabs font size'8px', '9px', '10px', '11px', '12px', '14px', '15px', '16px', '18px', '24px' or '30px'
designcustomStyles.tab.fontTypestringTabs font typeEx: 'Lucida Console, Monaco, monospace'
designcustomStyles.tab.generalSizestringDefault size for tabsEx: "20px"
designcustomStyles.tab.namestringLabel for the name of a new tab.Ex: "My cool new label"
designcustomStyles.tab.selectorColorstringSelected tab indicator colorExamples: '#000000', 'green', 'GREEN'
designcustomStyles.tab.widthTypestringTabs definition for width type"MANUAL", "AUTOMATIC", or "SAME_SIZE"
---For Input Box Items---------
designcustomStyles.filterCtrlInputBox.backgroundColorstringBackground color for the Filter Control. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.borderColorstringBorder color for the Filter Control. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.buttonBackgroundColorstringBackground color of the apply filter button in the Filter Control. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.buttonBorderColorstringBorder color of the apply filter button in the Filter Control. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.buttonTextColorstringText color of the apply filter button in the Filter Control. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.columnsArrayAn array of columns where the filter will be applied.Example: [{ "columnId": "xxxxx", "datasetId": "datasetxxx"}]
designcustomStyles.filterCtrlInputBox.defaultGroupingstringDate Grouping selected by the user in interaction mode. Note: To apply this default, you need to select a column using the “columns” field. If no column is selected through customization, the default will be loaded based on the column’s data type. You also have to select a list of valid groupings.Example: 'day', 'month', 'year'
designcustomStyles.filterCtrlInputBox.defaultValidatorObjectDefault validator selected for the Filter Control. Note: To apply this default, you need to select a column using the “columns” field. If no column is selected through customization, the default will be loaded based on the column’s data type. You also have to select a list of valid validators. The value of validator should be one of the strings from the list above.Example: 'CONTAINS'
designcustomStyles.filterCtrlInputBox.fontColorstringFont color for the filter control label (title). Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.fontFamilystringList of font types for the Filter Control.'Roboto, sans-serif', 'Arial, Helvetica, sans-serif', 'Lucida Console, Monaco, monospace'
designcustomStyles.filterCtrlInputBox.groupingsArrayDate Grouping list. Note: To apply this default, you need to select a column using the “columns” field. If no column is selected through customization, the default will be loaded based on the column’s data type.Example: ["day","month","quarter","week","year","quarter_only","month_only","day_only"]
designcustomStyles.filterCtrlInputBox.hintstringPlaceholder text for the filter field.'Enter a value...'
designcustomStyles.filterCtrlInputBox.selectorColorstringColor of the selector checkbox. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.titlestringName definition in the filter control, which can be a column name or any text from the panel configuration.Example: 'Column name'
designcustomStyles.filterCtrlInputBox.triggerstringDisplays the Apply Filter button or operates automatically. Two specific values: 'BUTTON' or 'AUTOMATIC'.'BUTTON', 'AUTOMATIC'
designcustomStyles.filterCtrlInputBox.triggerButtonLabelstringLabel to display text on the apply filter button. Any text string.Example: 'Filter'
designcustomStyles.filterCtrlInputBox.validatorsstring[]Object for the validators/operators list. Note: To apply this default, you need to select a column using the “columns” field. If no column is selected through customization, the default will be loaded based on the column’s data type. The value of validator should be one of the strings from the list above.Example: ["EQUALS","NOT_EQUAL"]
---For Multiselect List Items---------
designcustomStyles.filterCtrlMultiSelectList.backgroundColorstringDefault background color for filter controlExamples: '#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.borderColorstringBorder color for the Filter Control.Examples: '#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.buttonBackgroundColorstringDefault background color for filter buttonsExamples: '#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.buttonBorderColorstringDefault border color for filter buttonsExamples: '#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.buttonTextColorstringDefault text color for filter buttonsExamples: '#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.columnsArrayAn array of columns where the filter will be applied. Note: This default requires the fields sourceDataDataset, sourceDataDisplayColumn, and sourceDataValueColumn to be provided through customization to load the data associated.Example: [{ "columnId": "xxxxx", "datasetId": "datasetxxx"}]
designcustomStyles.filterCtrlMultiSelectList.defaultValidatorstringDefault validator/operator to load. The value of validator should be one of the strings from the list above.Examples: 'EQUALS', 'NOT_EQUAL'
designcustomStyles.filterCtrlMultiSelectList.fontColorstringDefault font color for the filter control label (title)Examples: '#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.fontFamilystringList of font types for Filter Control'Lucida Console, Monaco, monospace'
designcustomStyles.filterCtrlMultiSelectList.hintstringDefault placeholder for the input field"any string text"
designcustomStyles.filterCtrlMultiSelectList.selectorColorstringDefault color for the selector checkboxExamples: '#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.sourceDataDatasetstringThe ID of the dataset used for sourceDataDisplayColumn and sourceDataValueColumn properties. Required if columns is defined.Example: "datasetxxx"
designcustomStyles.filterCtrlMultiSelectList.sourceDataDisplayColumnstringThe column ID whose values will be shown as display labels in the filter control. Required if columns is defined.Example: "displayColumnId"
designcustomStyles.filterCtrlMultiSelectList.sourceDataValueColumnstringThe column ID whose values will be used as the actual filter values. Required if columns is defined.Example: "valueColumnId"
designcustomStyles.filterCtrlMultiSelectList.titlestringDefines the name in the filter control, which can be a column name or any text from the panel configuration.Example: "Column name"
designcustomStyles.filterCtrlMultiSelectList.triggerstringDisplays the Apply Filter button or operates automatically. Two specific values: 'BUTTON' or 'AUTOMATIC'.'BUTTON', 'AUTOMATIC'
designcustomStyles.filterCtrlMultiSelectList.triggerButtonLabelstringLabel to display the text on the apply filter button"My Label"
designcustomStyles.filterCtrlMultiSelectList.typestringGroups of values.'LIST' or 'DROPDOWN'
designcustomStyles.filterCtrlMultiSelectList.validatorsstring[]Object to list the validators/operators. The value of validator should be one of the strings from the list above.Example: ['EQUALS', 'NOT_EQUAL']
---For Date Picker Items---------
designcustomStyles.filterCtrlDatePicker.backgroundColorstringBackground color for the Filter Control. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.borderColorstringBorder color for the Filter Control. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.buttonBackgroundColorstringBackground color for the apply filter button. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.buttonBorderColorstringBorder color for the filter button. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.buttonTextColorstringText color for the filter button. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.columnsArrayAn array of columns where the filter will be applied. The data type of the columns should be date; otherwise, the column will not be valid for filtering.Example: [{ "columnId": "xxxxx", "datasetId": "datasetxxx"}]
designcustomStyles.filterCtrlDatePicker.defaultValidatorObjectDefault validator/operator to load. Only date-related validators are valid. The value of validator should be one of the strings from the list above.Example: 'AFTER'
designcustomStyles.filterCtrlDatePicker.fontColorstringDefault font color for the filter control label (title). Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.fontFamilystringList of font types for the filter control.'Roboto, sans-serif', 'Arial Black, Gadget, sans-serif', 'Lucida Console, Monaco, monospace'
designcustomStyles.filterCtrlDatePicker.hintstringDefault placeholder text for the filter control. Any text string.'Enter a date...'
designcustomStyles.filterCtrlDatePicker.selectorColorstringColor of the selector checkbox. Supported values: color names or Hex (e.g., '#000000', 'green', 'GREEN').'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.titlestringDefault name for the filter control. Any text string.Example: 'Column name'
designcustomStyles.filterCtrlDatePicker.triggerstringDefault trigger action, either with a button or automatic mode (on blur).'BUTTON'
designcustomStyles.filterCtrlDatePicker.triggerButtonLabelstringDefault text for the Apply Filter button. Any text string.Example: 'Filter'
designcustomStyles.filterCtrlDatePicker.validatorsstring[]Object to list the validators/operators. Note: To apply this default, you need to select a column using the “columns” field. If no column is selected through customization, the default will be loaded based on the column’s data type. The value of validator should be one of the strings from the list above.Example: ["EQUALS","AFTER"]
---For Filter Panel Items---------
design, preview, enduserfilterPanel.defaultViewstringSets the default state of the filter panel: "expanded" or "collapsed"."expanded" or "collapsed"
design, preview, enduserfilterPanel.displayIconbooleanSets the default visibility of the icon option in the filter panel settings.true or false
design, preview, enduserfilterPanel.displayColorbooleanSets the default visibility of the color option in the filter panel settings.true or false

submodules > Chart Panel

const subModules = {
chartPanel: {
keep: ['menu.download.pdf']
}
}
KeyDescription
headerThe entire header for the panel
header.qChartNameThe title of the panel
header.qFitPanelThe fit-to-panel button
header.qSortingThe sorting button
header.qChartSelectionThe chart selection button
header.qFilterThe filter and the options for filtering
header.optionMenuThe three dot button
header.optionMenu.qEditChartThe edit option inside the three dot button
header.optionMenu.qDuplicateChartThe duplicate option inside the three dot button
header.optionMenu.qDownloadChartThe download option inside the three dot button
header.optionMenu.qDownloadChart.qChartJPGThe JPG format in the download option
header.optionMenu.qDownloadChart.qChartPDFThe PDF format in the download option
header.optionMenu.qDownloadChart.qChartCSVThe CSV format in the download option
header.optionMenu.qDownloadChart.qChartSummaryThe CSV summary format in the download option
header.optionMenu.qDownloadChart.qChartExcelThe Excel format in the download option
header.qColumnReplacementThe column replacement section in column settings
header.qColumnAggregationThe column aggregation section in column settings
optionDateGroupingThe column date grouping section in column settings
optionDateGrouping.qDayOnlyThe option for (Day Month) in date grouping dropdown
optionDateGrouping.qMonthThe option for (Month, Year) in date grouping dropdown
optionDateGrouping.qMonthOnlyThe option for (Month) in date grouping dropdown
optionDateGrouping.qQuarterThe option for (Quarter, Year) in date grouping dropdown
optionDateGrouping.qQuarterOnlyThe option for (Quarter) in date grouping dropdown
optionDateGrouping.qWeekThe option for (Week, Year) in date grouping dropdown
optionDateGrouping.qYearThe option for (Year) in date grouping dropdown
optionDateGrouping.qDayThe option for (Full Date) in date grouping dropdown
optionDateGrouping.qHourThe option for (Date, Hour) in date grouping dropdown
optionDateGrouping.qHourOnlyThe option for (Hour) in date grouping dropdown
optionDateGrouping.qMinuteThe option for (Date, Minute) in date grouping dropdown
optionDateGrouping.qMinuteOnlyThe option for (Minute) in date grouping dropdown
optionDateGrouping.qSecondThe option for (Date, Second) in date grouping dropdown
optionDateGrouping.qSecondOnlyThe option for (Second) in date grouping dropdown

conditional blocks

You can use the conditional block to show/hide elements based on widget metadata or attributes (e.g., a chart's category). At present, the only valid value for the field attribute is "category", which can have a value of: "metric", "chart", or "summary".

"conditional": [ // Please check your conditions to avoid any logical conflicts.
{
"condition": {
"field": "category",
"operator": "=",
"value": "metric"
},
"keep": ["*.download.excel"]
},
{
"condition": {
"field": "category",
"operator": "=",
"value": "chart"
},
"keep": ["*.download.pdf"]
}
]