Customization Views

The views object defines the available UI components and controls for each dashboard mode (such as design, endUser, list, and preview).

For a complete guide on how to use the views object, including examples and configuration options, see the Dashboard Customization documentation.

Views Parameters

The following sections list the keys and their descriptions for each view type, helping you understand what can be customized or shown/hidden in each view.

List View

Key	Description
navBar	Main top bar.
navBar.qAppTitle	App title in the main top bar.
assetList	List options.
assetList.asset	Options inside the asset concept.
assetList.asset.card	Dashboard cards listed in the Card View.
assetList.asset.card.qFavorite	The "Add to Favorites" option displayed in the dashboard card.
assetList.asset.card.qCreatedDate	Date "Created" option in the dashboard card.
assetList.asset.card.qLastModifDate	Date "Last Modified" displayed in the dashboard card.
assetList.asset.card.qStatus	Dashboard status option in the dashboard card.
assetList.asset.card.qNumberOfCharts	"Number Of Charts" in the dashboard displayed in the dashboard card.
assetList.asset.card.qSharing	"Sharing" status displayed in the dashboard card.
assetList.asset.card.qOwner	Dashboard owner in the dashboard card.
assetList.asset.card.qDescription	Description of the dashboard displayed in the dashboard card.
assetList.asset.optionMenu	List options for the menu.
assetList.asset.optionMenu.qEditDash	Edit option inside the menu for the list.
assetList.asset.optionMenu.qUseDash	Use option inside the menu for the list. Only visisble when a dashboard is published.
assetList.asset.optionMenu.qRenameDash	Rename option inside the menu for the list.
assetList.asset.optionMenu.qDeleteDash	Delete option inside the menu for the list.
assetList.asset.optionMenu.qDuplDash	Duplicate option inside the menu for the list.
assetList.asset.table	Dashboards listed in the Table View.
assetList.asset.table.qFavorite	"Add to Favorites" option displayed in the dashboard record.
assetList.asset.table.qCreatedDate	Date "Created" column in the dashboard table.
assetList.asset.table.qLastModifDate	Date "Last Modified" column in the dashboard table.
assetList.asset.table.qStatus	Dashboard status column in the dashboard table .
assetList.asset.table.qNumberOfCharts integer	"Number Of Charts" column in the dashboard table.
assetList.asset.table.qSharing	"Sharing" column dashboard table.
assetList.asset.table.qOwner	"Owner" column in the dashboard table.
assetList.asset.table.qDescription	"Description" column in the dashboard table.
controlBarLeft	List options for the header.
controlBarLeft.qCreateDash	Create button for the asset list.
controlBarRight	List of options on the right.
controlBarRight.qSwitchView	Switch button on the asset list.
controlBarRight.timezone	Timezone label.
controlBarRight.qFilterBy	Filter by control.
controlBarRight.qSortBy	Sort by control. Only available for the card mode on the asset list.
controlBarRight.qSearch	Search input box.
controlBarRight.qSelectColumn	Select columns dropdown. Only available for the table mode on the asset list.

Design View

Key	Description
navBar	Main top bar.
navBar.qBackButton	Back button on the nav bar. Only available when a dashboard is selected.
navBar.qAppTitle	App title in the main top bar.
header	Header where the dashboard name, description, and favorite are located.
header.qDashFavorite	Dashboard favorite option.
header.qDashName	Dashboard name.
header.qDashDesc	Dashboard description.
controlBarRight	List of options on the right.
controlBarRight.qStatus	Status label for the dashboard.
controlBarRight.qPreview	Allows the preview mode visualization.
controlBarRight.qDiscard	Button for discarding changes.
controlBarRight.qPublish	Button for publishing a new version of the dashboard.
controlBarRight.qUnpublish	Button for unpublishing a dashboard.
controlBarRight.qSwitchMode	Option to switch between Design and Interaction modes. Only available when a dashboard is published.
menuBar	Menu. If the toolbar and the menu are hidden, the entire bar will be hidden.
menuBar.file	File menu.
menuBar.file.qMnuCreateDash	New dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
menuBar.file.qMnuOpenDash	Open dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
menuBar.file.qMnuDuplicateDash	Duplicate dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
menuBar.file.qMnuCanvasSize	Canvas size option inside the file menu. Only available if the canvas mode is Fixed.
menuBar.file.qMnuThemes	Themes option inside the file menu.
menuBar.file.qMnuDeleteDash	Delete dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget.
menuBar.file.qMnuDownloadDash	Download options for the dashboard.
menuBar.file.qMnuDownloadDash.qDashPDF	PDF download option.
menuBar.file.qMnuDownloadDash.qDashCSV	CSV download option.
menuBar.file.qMnuDownloadDash.qDashExcel	Excel download option.
menuBar.file.qMnuDownloadDash.qDashDataset	Dataset download option.
menuBar.file.qCreateDataset	The custom dataset options inside the file menu.
menuBar.file.qCreateDataset.qCreateCustomDataset	Create custom dataset option inside the file menu.
menuBar.file.qCreateDataset.qViewCustomDataset	View custom datasets option inside the file menu.
menuBar.edit	Edit menu.
menuBar.edit.qCopyElement	Copy option inside the edit menu. The option is available using the CTRL + C shortcut.
menuBar.edit.qPasteElement	Paste option inside the edit menu. The option is available using the CTRL + V shortcut.
menuBar.edit.qCutElement	Cut option inside the edit menu. The option is available using the CTRL + X shortcut.
menuBar.edit.qRemoveElement	Remove option inside the edit menu. The option is available using the Backspace/Delete shortcut.
menuBar.edit.qDuplElement	Duplicate option inside the edit menu. The option is available using the CTRL + D shortcut.
menuBar.edit.qSelectAllElem	Select all option inside the edit menu. The option is available using the CTRL + Shift + K shortcut.
menuBar.grid	Grid menu.
menuBar.grid.qMnuSnapToGrid	Snap to grid option inside the grid menu.
menuBar.grid.qMnuDisplayGrid	Hide/display grid option inside the grid menu.
menuBar.grid.qMnuSwitchGrid	Switch grid type option inside the grid menu.
menuBar.insert	Insert menu.
menuBar.insert.qMnuInsertChart	Insert chart group inside the insert menu.
menuBar.insert.qMnuInsertChart.qMnuExistingChart	Option for inserting an existing chart from the gallery for the insert menu.
menuBar.insert.qMnuInsertChart.qMnuNewChart	Option for inserting a new chart from the chart builder for the insert menu.
menuBar.insert.qMnuInsertChart.qMnuNewChartAI	Option for inserting a new chart from the AI modal.
menuBar.insert.qMnuInsertFilterCtrl	Insert filter control elements group inside the insert menu.
menuBar.insert.qMnuInsertFilterCtrl.qMnuDatePicker	Option for inserting a new date picker.
menuBar.insert.qMnuInsertFilterCtrl.qMnuInputBox	Option for inserting a new input box.
menuBar.insert.qMnuInsertFilterCtrl.qMnuMultiSelectList	Option for inserting a new value list.
menuBar.insert.qMnuInsertText	Option for inserting a text element.
menuBar.insert.qMnuInsertImage	Option for inserting an image element.
menuBar.insert.qMnuInsertButton	Option for inserting a button element.
menuBar.insert.qMnuInsertContainer	Option for inserting a container element.
menuBar.insert.qMnuInsertHeader	Option for inserting a header container.
menuBar.insert.qMnuInsertTabs	Option for adding tabs to the dashboard.
menuBar.qMnuArrange	Arrange menu.
menuBar.qMnuArrange.qMnuBringToFront	Option for sending an element to the front from the arrange menu.
menuBar.qMnuArrange.qMnuSendToBack	Option for sending an element to the back from the arrange menu.
menuBar.qMnuArrange.qMnuAlign	Align group inside the arrange menu.
menuBar.qMnuArrange.qMnuAlign.qAlignRight	Option for aligning to the right.
menuBar.qMnuArrange.qMnuAlign.qAlignLeft	Option for aligning to the left.
menuBar.qMnuArrange.qMnuAlign.qAlignCenter	Option for aligning to the center.
menuBar.qMnuArrange.qMnuAlign.qAlignTop	Option for aligning to the top.
menuBar.qMnuArrange.qMnuAlign.qAlignMiddle	Option for aligning to the middle.
menuBar.qMnuArrange.qMnuAlign.qAlignBottom	Option for aligning to the bottom.
toolBar	Toolbar section. If the toolbar and the menu are hidden, the entire bar will be hidden.
toolBar.qCanvasSize	Canvas size option inside the toolbar.
toolBar.qInsertChart	Insert chart group inside the toolbar.
toolBar.qInsertChart.qExistingChart	Option for inserting existing chart from the gallery for the toolbar.
toolBar.qInsertChart.qNewChart	Option for inserting a new chart from the chart builder for the toolbar.
toolBar.qInsertChart.qNewChartAI	Option for inserting a new chart from the AI modal.
toolBar.qInsertFilterCtrl	Insert filter control elements group inside the toolbar.
toolBar.qInsertFilterCtrl.qDatePicker	Option for inserting a new date picker.
toolBar.qInsertFilterCtrl.qInputBox	Option for inserting a new input box.
toolBar.qInsertFilterCtrl.qMultiSelectList	Option for inserting a new value list.
toolBar.qInsertText	Option for inserting a text element.
toolBar.qInsertImage	Option for inserting an image element.
toolBar.qInsertButton	Option for inserting a button element.
toolBar.qInsertContainer	Option for inserting a container element.
toolBar.grid	Grid group inside the toolbar.
toolBar.grid.qSnapToGrid	Snap to grid option inside the toolbar.
toolBar.grid.qDisplayGrid	Hide/display grid option inside the toolbar.
toolBar.grid.qSwitchGrid	Switch grid type option inside the toolbar.
toolBar.qDownloadDash	Download options for the dashboard.
toolBar.qDownloadDash.qDashPDF	PDF download option.
toolBar.qDownloadDash.qDashCSV	CSV download option.
toolBar.qDownloadDash.qDashExcel	Excel download option.
toolBar.qDownloadDash.qDashDataset	Dataset download option.
toolBar.qArrange	Arrange group inside the toolbar.
toolBar.qArrange.qBringToFront	Option for sending an element to the front from the toolbar.
toolBar.qArrange.qSendToBack	Option for sending an element to the back from the toolbar.
toolBar.qResponsiveView	Responsive view group in the toolbar.
toolBar.qResponsiveView.qDesktop	Desktop view for the dashboard.
toolBar.qResponsiveView.qTablet	Tablet view for the dashboard.
toolBar.qResponsiveView.qMobile	Mobile view for the dashboard.
toolBar.qResponsiveView.qBreakpoints	Option to open the modal for modifying the breakpoints. Only available in responsive canvas.
toolBar.qAlign	Align group inside the toolbar.
toolBar.qAlign.qAlignRight	Option for aligning to the right.
toolBar.qAlign.qAlignLeft	Option for aligning to the left.
toolBar.qAlign.qAlignCenter	Option for aligning to the center.
toolBar.qAlign.qAlignTop	Option for aligning to the top.
toolBar.qAlign.qAlignMiddle	Option for aligning to the middle.
toolBar.qAlign.qAlignBottom	Option for aligning to the bottom.
toolBar.qRespGridMargins	Configuration for margins. Only available in responsive canvas.
toolBar.qRespGridColumns	Configuration for number of columns. Only available in responsive canvas.
toolBar.qThemes	Themes option inside the toolbar.
toolBar.qUndoRedo	Undo/redo options.
toolBar.qCreateDataset	Custom Dataset options.
toolBar.qCreateDataset.qCreateCustomDataset	Option to create a new custom dataset.
toolBar.qCreateDataset.qViewCustomDataset	Option for viewing custom datasets.
configPanel	Configuration panel for the items and containers.
filterPanel	Filters panel.
filterPanel.qAddFilter	Add button for the filter panel.
filterPanel.qEnabDisabAllFilters	Option for enable/disable all the filters.
filterPanel.qDeleteAllFilters	Option for removing all the filters.
filterPanel.qFilterSettings	Settings buttons in the filter panel.
filterPanel.dashFilterScope	Settings associated to the dashboard scope.
filterPanel.dashFilterScope.qEditFilter	Edit button in the dashboard scope.
filterPanel.dashFilterScope.qEnabDisabFilter	Enable/disable button in the dashboard scope.
filterPanel.dashFilterScope.qDeleteFilter	Remove option in the dashboard scope.
filterPanel.tabFilterScope	Settings associated to the tab scope.
filterPanel.tabFilterScope.qEditFilter	Edit button in the tab scope.
filterPanel.tabFilterScope.qEnabDisabFilter	Enable/disable button in the tab scope.
filterPanel.tabFilterScope.qDeleteFilter	Remove option in the tab scope.
filterPanel.panelFilterScope	Settings associated to the chart panel scope.
filterPanel.panelFilterScope.qEditFilter	Edit button in the chart panel scope.
filterPanel.panelFilterScope.qEnabDisabFilter	Enable/disable button in the chart panel scope.
filterPanel.panelFilterScope.qDeleteFilter	Remove option in the chart panel scope.
downloadModal	Options associated with the download modal.
downloadModal.qScheduleOption	Schedule button inside the download modal.
downloadModal.qSubscribeOption	Subscribe tab within the Download modal.
downloadModal.qSubscribeExternalUsers	Option to add external users using the Enter key within the Subscribe tab.

Preview View

Key	Description
navBar	Main top bar.
navBar.qBackButton	Back button on the nav bar.
navBar.qAppTitle	App title in the main top bar.
header	Bar located the dashboard name.
header.qDashFavorite	Dashboard favorite option.
header.qDashName	Dashboard name.
header.qDashDesc	Dashboard description.
controlBarRight	Options next to the control bar.
controlBarRight.qStatus	Status label for the dashboard.
controlBarRight.q	Design button inside the edit bar.
filterPanel	Filters panel.
filterPanel.qAddFilter	Add button for the filter panel.
filterPanel.qEnabDisabAllFilters	Option to enable and disable all filters.
filterPanel.qDeleteAllFilters	Option for removing all the filters.
filterPanel.qFilterSettings	Settings buttons in the filter panel.
filterPanel.dashFilterScope	Settings associated with the dashboard scope.
filterPanel.dashFilterScope.qEditFilter	Edit button in the dashboard scope.
filterPanel.dashFilterScope.qEnabDisabFilter	Enable/disable button in the dashboard scope.
filterPanel.dashFilterScope.qDeleteFilter	Remove option in the dashboard scope.
filterPanel.tabFilterScope	Settings associated to the tab scope.
filterPanel.tabFilterScope.qEditFilter	Edit button in the tab scope.
filterPanel.tabFilterScope.qEnabDisabFilter	Enable/disable button in the tab scope.
filterPanel.tabFilterScope.qDeleteFilter	Remove option in the tab scope.
filterPanel.panelFilterScope	Settings associated to the chart panel scope.
filterPanel.panelFilterScope.qEditFilter	Edit button in the chart panel scope.
filterPanel.panelFilterScope.qEnabDisabFilter	Enable/disable button in the chart panel scope.
filterPanel.panelFilterScope.qDeleteFilter	Remove option in the chart panel scope.

EndUser View

Key	Description
navBar	Main top bar.
navBar.qBackButton	Back button on the nav bar. Only available when a dashboard is selected.
navBar.qAppTitle	App title in the main top bar.
downloadModal	Options associated with the download modal.
downloadModal.qScheduleOption	Schedule button inside the download modal.
filterPanel	Filters panel.
filterPanel.qAddFilter	Add button for the filter panel.
filterPanel.qEnabDisabAllFilters	Option for enable/disable all the filters.
filterPanel.qDeleteAllFilters	Option for removing all the filters.
filterPanel.qFilterSettings	Settings buttons in the filter panel.
filterPanel.dashFilterScope	Settings associated with the dashboard scope.
filterPanel.dashFilterScope.qEditFilter	Edit button in the dashboard scope.
filterPanel.dashFilterScope.qEnabDisabFilter	Enable/disable button in the dashboard scope.
filterPanel.dashFilterScope.qDeleteFilter	Remove option in the dashboard scope.
filterPanel.tabFilterScope	Settings associated to the tab scope.
filterPanel.tabFilterScope.qEditFilter	Edit button in the tab scope.
filterPanel.tabFilterScope.qEnabDisabFilter	Enable/disable button in the tab scope.
filterPanel.tabFilterScope.qDeleteFilter	Remove option in the tab scope.
filterPanel.panelFilterScope	Settings associated to the chart panel scope.
filterPanel.panelFilterScope.qEditFilter	Edit button in the chart panel scope.
filterPanel.panelFilterScope.qEnabDisabFilter	Enable/disable button in the chart panel scope.
filterPanel.panelFilterScope.qDeleteFilter	Remove option in the chart panel scope.
toolBar	Toolbar section.
toolBar.qDashVersion	Dashboard version indicator.
toolBar.qGetDashVersion	Button for switching between dashboard versions.
toolBar.qUndoRedo	Undo/redo options.
toolBar.qDownloadDash	Download options for the dashboard.
toolBar.qDownloadDash.qDashPDF	PDF download option.
toolBar.qDownloadDash.qDashCSV	CSV download option.
toolBar.qDownloadDash.qDashExcel	Excel download option.
toolBar.qDownloadDash.qDashDataset	Dataset download option.
toolBar.qHiddenItems	Button for the hidden elements.
toolBar.qDiscard	Discard button.
toolBar.qSave	Save button.
toolBar.qHideToolBar	Hide toolbar button.
toolBar.qSwitchMode	Option to switch between Design and Interaction mode. Only available when a dashboard is published.