Customization Views
The views object defines the available UI components and controls for each dashboard mode (such as design, endUser, list, and preview). This page lists all possible keys and their descriptions, helping you understand what can be customized or shown/hidden in each view.
For a complete guide on how to use the views object, including examples and configuration options, see the Dashboard Customization documentation.
The views Parameters
| View | Key | Description |
|---|---|---|
| list | navBar | The main top bar. |
| list | navBar.qAppTitle | The app title in the main top bar. |
| list | assetList | The list options. |
| list | assetList.asset | The options inside the asset concept. |
| list | assetList.asset.optionMenu | The list options for the menu. |
| list | assetList.asset.optionMenu.qEditDash | The edit option inside the menu for the list. |
| list | assetList.asset.optionMenu.qUseDash | The use option inside the menu for the list. Only visisble when a dashboard is published. |
| list | assetList.asset.optionMenu.qRenameDash | The rename option inside the menu for the list. |
| list | assetList.asset.optionMenu.qDeleteDash | The delete option inside the menu for the list. |
| list | assetList.asset.optionMenu.qDuplDash | The duplicate option inside the menu for the list. |
| list | controlBarLeft | The list options for the header. |
| list | controlBarLeft.qCreateDash | The create button for the asset list. |
| list | controlBarRight | The list of options on the right. |
| list | controlBarRight.qSwitchView | The switch button on the asset list. |
| list | controlBarRight.timezone | The timezone label. |
| list | controlBarRight.qFilterBy | The filter by control. |
| list | controlBarRight.qSortBy | The sort by control. Only available for the card mode on the asset list. |
| list | controlBarRight.qSearch | The search input box. |
| list | controlBarRight.qSelectColumn | The select columns dropdown. Only available for the table mode on the asset list. |
| design | navBar | The main top bar. |
| design | navBar.qBackButton | The back button on the nav bar. Only available when a dashboard is selected. |
| design | navBar.qAppTitle | The app title in the main top bar. |
| design | header | The header where the dashboard name, description, and favorite are located. |
| design | header.qDashFavorite | The dashboard favorite option. |
| design | header.qDashName | The dashboard name. |
| design | header.qDashDesc | The dashboard description. |
| design | controlBarRight | The list of options on the right. |
| design | controlBarRight.qStatus | The status label for the dashboard. |
| design | controlBarRight.qPreview | Allows the preview mode visualization. |
| design | controlBarRight.qDiscard | The button for discarding changes. |
| design | controlBarRight.qPublish | The button for publishing a new version of the dashboard. |
| design | controlBarRight.qUnpublish | The button for unpublishing a dashboard. |
| design | controlBarRight.qSwitchMode | The option to switch between Design and Interaction modes. Only available when a dashboard is published. |
| design | menuBar | The menu. If the toolbar and the menu are hidden, the entire bar will be hidden. |
| design | menuBar.file | The file menu. |
| design | menuBar.file.qMnuCreateDash | The new dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget. |
| design | menuBar.file.qMnuOpenDash | The open dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget. |
| design | menuBar.file.qMnuDuplicateDash | The duplicate dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget. |
| design | menuBar.file.qMnuCanvasSize | The canvas size option inside the file menu. Only available if the canvas mode is Fixed. |
| design | menuBar.file.qMnuThemes | The themes option inside the file menu. |
| design | menuBar.file.qMnuDeleteDash | The delete dashboard option inside the file menu. Only applies if no dashboardId was passed when embedding the widget. |
| design | menuBar.file.qMnuDownloadDash | Download options for the dashboard. |
| design | menuBar.file.qMnuDownloadDash.qDashPDF | PDF download option. |
| design | menuBar.file.qMnuDownloadDash.qDashCSV | CSV download option. |
| design | menuBar.file.qMnuDownloadDash.qDashExcel | Excel download option. |
| design | menuBar.file.qMnuDownloadDash.qDashDataset | Dataset download option. |
| design | menuBar.file.qCreateDataset | The custom dataset options inside the file menu. |
| design | menuBar.file.qCreateDataset.qCreateCustomDataset | The create custom dataset option inside the file menu. |
| design | menuBar.file.qCreateDataset.qViewCustomDataset | The view custom datasets option inside the file menu. |
| design | menuBar.edit | The edit menu. |
| design | menuBar.edit.qCopyElement | The copy option inside the edit menu. The option is available using the CTRL + C shortcut. |
| design | menuBar.edit.qPasteElement | The paste option inside the edit menu. The option is available using the CTRL + V shortcut. |
| design | menuBar.edit.qCutElement | The cut option inside the edit menu. The option is available using the CTRL + X shortcut. |
| design | menuBar.edit.qRemoveElement | The remove option inside the edit menu. The option is available using the Backspace/Delete shortcut. |
| design | menuBar.edit.qDuplElement | The duplicate option inside the edit menu. The option is available using the CTRL + D shortcut. |
| design | menuBar.edit.qSelectAllElem | The select all option inside the edit menu. The option is available using the CTRL + Shift + K shortcut. |
| design | menuBar.grid | The grid menu. |
| design | menuBar.grid.qMnuSnapToGrid | The snap to grid option inside the grid menu. |
| design | menuBar.grid.qMnuDisplayGrid | The hide/display grid option inside the grid menu. |
| design | menuBar.grid.qMnuSwitchGrid | The switch grid type option inside the grid menu. |
| design | menuBar.insert | The insert menu. |
| design | menuBar.insert.qMnuInsertChart | The insert chart group inside the insert menu. |
| design | menuBar.insert.qMnuInsertChart.qMnuExistingChart | The option for inserting an existing chart from the gallery for the insert menu. |
| design | menuBar.insert.qMnuInsertChart.qMnuNewChart | The option for inserting a new chart from the chart builder for the insert menu. |
| design | menuBar.insert.qMnuInsertChart.qMnuNewChartAI | The option for inserting a new chart from the AI modal. |
| design | menuBar.insert.qMnuInsertFilterCtrl | The insert filter control elements group inside the insert menu. |
| design | menuBar.insert.qMnuInsertFilterCtrl.qMnuDatePicker | The option for inserting a new date picker. |
| design | menuBar.insert.qMnuInsertFilterCtrl.qMnuInputBox | The option for inserting a new input box. |
| design | menuBar.insert.qMnuInsertFilterCtrl.qMnuMultiSelectList | The option for inserting a new value list. |
| design | menuBar.insert.qMnuInsertText | The option for inserting a text element. |
| design | menuBar.insert.qMnuInsertImage | The option for inserting an image element. |
| design | menuBar.insert.qMnuInsertButton | The option for inserting a button element. |
| design | menuBar.insert.qMnuInsertContainer | The option for inserting a container element. |
| design | menuBar.insert.qMnuInsertHeader | The option for inserting a header container. |
| design | menuBar.insert.qMnuInsertTabs | The option for adding tabs to the dashboard. |
| design | menuBar.qMnuArrange | The arrange menu. |
| design | menuBar.qMnuArrange.qMnuBringToFront | The option for sending an element to the front from the arrange menu. |
| design | menuBar.qMnuArrange.qMnuSendToBack | The option for sending an element to the back from the arrange menu. |
| design | menuBar.qMnuArrange.qMnuAlign | The align group inside the arrange menu. |
| design | menuBar.qMnuArrange.qMnuAlign.qAlignRight | The option for aligning to the right. |
| design | menuBar.qMnuArrange.qMnuAlign.qAlignLeft | The option for aligning to the left. |
| design | menuBar.qMnuArrange.qMnuAlign.qAlignCenter | The option for aligning to the center. |
| design | menuBar.qMnuArrange.qMnuAlign.qAlignTop | The option for aligning to the top. |
| design | menuBar.qMnuArrange.qMnuAlign.qAlignMiddle | The option for aligning to the middle. |
| design | menuBar.qMnuArrange.qMnuAlign.qAlignBottom | The option for aligning to the bottom. |
| design | toolBar | The toolbar section. If the toolbar and the menu are hidden, the entire bar will be hidden. |
| design | toolBar.qCanvasSize | The canvas size option inside the toolbar. |
| design | toolBar.qInsertChart | The insert chart group inside the toolbar. |
| design | toolBar.qInsertChart.qExistingChart | The option for inserting existing chart from the gallery for the toolbar. |
| design | toolBar.qInsertChart.qNewChart | The option for inserting a new chart from the chart builder for the toolbar. |
| design | toolBar.qInsertChart.qNewChartAI | The option for inserting a new chart from the AI modal. |
| design | toolBar.qInsertFilterCtrl | The insert filter control elements group inside the toolbar. |
| design | toolBar.qInsertFilterCtrl.qDatePicker | The option for inserting a new date picker. |
| design | toolBar.qInsertFilterCtrl.qInputBox | The option for inserting a new input box. |
| design | toolBar.qInsertFilterCtrl.qMultiSelectList | The option for inserting a new value list. |
| design | toolBar.qInsertText | The option for inserting a text element. |
| design | toolBar.qInsertImage | The option for inserting an image element. |
| design | toolBar.qInsertButton | The option for inserting a button element. |
| design | toolBar.qInsertContainer | The option for inserting a container element. |
| design | toolBar.grid | The grid group inside the toolbar. |
| design | toolBar.grid.qSnapToGrid | The snap to grid option inside the toolbar. |
| design | toolBar.grid.qDisplayGrid | The hide/display grid option inside the toolbar. |
| design | toolBar.grid.qSwitchGrid | The switch grid type option inside the toolbar. |
| design | toolBar.qDownloadDash | Download options for the dashboard. |
| design | toolBar.qDownloadDash.qDashPDF | PDF download option. |
| design | toolBar.qDownloadDash.qDashCSV | CSV download option. |
| design | toolBar.qDownloadDash.qDashExcel | Excel download option. |
| design | toolBar.qDownloadDash.qDashDataset | Dataset download option. |
| design | toolBar.qArrange | The arrange group inside the toolbar. |
| design | toolBar.qArrange.qBringToFront | The option for sending an element to the front from the toolbar. |
| design | toolBar.qArrange.qSendToBack | The option for sending an element to the back from the toolbar. |
| design | toolBar.qResponsiveView | The responsive view group in the toolbar. |
| design | toolBar.qResponsiveView.qDesktop | The desktop view for the dashboard. |
| design | toolBar.qResponsiveView.qTablet | The tablet view for the dashboard. |
| design | toolBar.qResponsiveView.qMobile | The mobile view for the dashboard. |
| design | toolBar.qResponsiveView.qBreakpoints | The option to open the modal for modifying the breakpoints. Only available in responsive canvas. |
| design | toolBar.qAlign | The align group inside the toolbar. |
| design | toolBar.qAlign.qAlignRight | The option for aligning to the right. |
| design | toolBar.qAlign.qAlignLeft | The option for aligning to the left. |
| design | toolBar.qAlign.qAlignCenter | The option for aligning to the center. |
| design | toolBar.qAlign.qAlignTop | The option for aligning to the top. |
| design | toolBar.qAlign.qAlignMiddle | The option for aligning to the middle. |
| design | toolBar.qAlign.qAlignBottom | The option for aligning to the bottom. |
| design | toolBar.qRespGridMargins | The configuration for margins. Only available in responsive canvas. |
| design | toolBar.qRespGridColumns | The configuration for number of columns. Only available in responsive canvas. |
| design | toolBar.qThemes | The themes option inside the toolbar. |
| design | toolBar.qUndoRedo | The undo/redo options. |
| design | toolBar.qCreateDataset | Custom Dataset options. |
| design | toolBar.qCreateDataset.qCreateCustomDataset | The option to create a new custom dataset. |
| design | toolBar.qCreateDataset.qViewCustomDataset | The option for viewing custom datasets. |
| design | configPanel | The configuration panel for the items and containers. |
| design | filterPanel | The filters panel. |
| design | filterPanel.qAddFilter | The add button for the filter panel. |
| design | filterPanel.qEnabDisabAllFilters | The option for enable/disable all the filters. |
| design | filterPanel.qDeleteAllFilters | The option for removing all the filters. |
| design | filterPanel.qFilterSettings | The settings buttons in the filter panel. |
| design | filterPanel.dashFilterScope | Settings associated to the dashboard scope. |
| design | filterPanel.dashFilterScope.qEditFilter | The edit button in the dashboard scope. |
| design | filterPanel.dashFilterScope.qEnabDisabFilter | The enable/disable button in the dashboard scope. |
| design | filterPanel.dashFilterScope.qDeleteFilter | The remove option in the dashboard scope. |
| design | filterPanel.tabFilterScope | Settings associated to the tab scope. |
| design | filterPanel.tabFilterScope.qEditFilter | The edit button in the tab scope. |
| design | filterPanel.tabFilterScope.qEnabDisabFilter | The enable/disable button in the tab scope. |
| design | filterPanel.tabFilterScope.qDeleteFilter | The remove option in the tab scope. |
| design | filterPanel.panelFilterScope | Settings associated to the chart panel scope. |
| design | filterPanel.panelFilterScope.qEditFilter | The edit button in the chart panel scope. |
| design | filterPanel.panelFilterScope.qEnabDisabFilter | The enable/disable button in the chart panel scope. |
| design | filterPanel.panelFilterScope.qDeleteFilter | The remove option in the chart panel scope. |
| design | downloadModal | The options associated with the download modal. |
| design | downloadModal.qScheduleOption | The schedule button inside the download modal. |
| design | downloadModal.qSubscribeOption | The Subscribe tab within the Download modal. |
| design | downloadModal.qSubscribeExternalUsers | The option to add external users using the Enter key within the Subscribe tab. |
| preview | navBar | The main top bar |
| preview | navBar.qBackButton | The back button on the nav bar |
| preview | navBar.qAppTitle | The app title in the main top bar |
| preview | header | The bar where is located the dashboard name |
| preview | header.qDashFavorite | The dashboard favorite option |
| preview | header.qDashName | The dashboard name |
| preview | header.qDashDesc | The dashboard description |
| preview | controlBarRight | The list of options on the right side of the control bar. |
| preview | controlBarRight.qStatus | The status label for the dashboard |
| preview | controlBarRight.qDesign | The design button inside the edit bar |
| preview | filterPanel | The filters panel |
| preview | filterPanel.qAddFilter | The add button for the filter panel |
| preview | filterPanel.qEnabDisabAllFilters | The option for enable/disable all the filters |
| preview | filterPanel.qDeleteAllFilters | The option for removing all the filters |
| preview | filterPanel.qFilterSettings | The settings buttons in the filter panel |
| preview | filterPanel.dashFilterScope | settings associated to the dashboard scope |
| preview | filterPanel.dashFilterScope.qEditFilter | The edit button in the dashboard scope |
| preview | filterPanel.dashFilterScope.qEnabDisabFilter | The enable/disable button in the dashboard scope |
| preview | filterPanel.dashFilterScope.qDeleteFilter | The remove option in the dashboard scope |
| preview | filterPanel.tabFilterScope | settings associated to the tab scope |
| preview | filterPanel.tabFilterScope.qEditFilter | The edit button in the tab scope |
| preview | filterPanel.tabFilterScope.qEnabDisabFilter | The enable/disable button in the tab scope |
| preview | filterPanel.tabFilterScope.qDeleteFilter | The remove option in the tab scope |
| preview | filterPanel.panelFilterScope | settings associated to the chart panel scope |
| preview | filterPanel.panelFilterScope.qEditFilter | The edit button in the chart panel scope |
| preview | filterPanel.panelFilterScope.qEnabDisabFilter | The enable/disable button in the chart panel scope |
| preview | filterPanel.panelFilterScope.qDeleteFilter | The remove option in the chart panel scope |
| endUser | navBar | The main top bar |
| endUser | navBar.qBackButton | The back button on the nav bar. Only available when a dashboard is selected |
| endUser | navBar.qAppTitle | The app title in the main top bar |
| endUser | downloadModal | The options associated to the download modal |
| endUser | downloadModal.qScheduleOption | The schedule button inside the download modal |
| endUser | filterPanel | The filters panel |
| endUser | filterPanel.qAddFilter | The add button for the filter panel |
| endUser | filterPanel.qEnabDisabAllFilters | The option for enable/disable all the filters |
| endUser | filterPanel.qDeleteAllFilters | The option for removing all the filters |
| endUser | filterPanel.qFilterSettings | The settings buttons in the filter panel |
| endUser | filterPanel.dashFilterScope | settings associated to the dashboard scope |
| endUser | filterPanel.dashFilterScope.qEditFilter | The edit button in the dashboard scope |
| endUser | filterPanel.dashFilterScope.qEnabDisabFilter | The enable/disable button in the dashboard scope |
| endUser | filterPanel.dashFilterScope.qDeleteFilter | The remove option in the dashboard scope |
| endUser | filterPanel.tabFilterScope | settings associated to the tab scope |
| endUser | filterPanel.tabFilterScope.qEditFilter | The edit button in the tab scope |
| endUser | filterPanel.tabFilterScope.qEnabDisabFilter | The enable/disable button in the tab scope |
| endUser | filterPanel.tabFilterScope.qDeleteFilter | The remove option in the tab scope |
| endUser | filterPanel.panelFilterScope | settings associated to the chart panel scope |
| endUser | filterPanel.panelFilterScope.qEditFilter | The edit button in the chart panel scope |
| endUser | filterPanel.panelFilterScope.qEnabDisabFilter | The enable/disable button in the chart panel scope |
| endUser | filterPanel.panelFilterScope.qDeleteFilter | The remove option in the chart panel scope |
| endUser | toolBar | The toolbar section |
| endUser | toolBar.qDashVersion | The dashboard version indicator |
| endUser | toolBar.qGetDashVersion | The button for switching between dashboard versions |
| endUser | toolBar.qUndoRedo | The undo/redo options |
| endUser | toolBar.qDownloadDash | Download options for the dashboard |
| endUser | toolBar.qDownloadDash.qDashPDF | PDF download option |
| endUser | toolBar.qDownloadDash.qDashCSV | CSV download option |
| endUser | toolBar.qDownloadDash.qDashExcel | Excel download option |
| endUser | toolBar.qDownloadDash.qDashDataset | Dataset download option |
| endUser | toolBar.qHiddenItems | The button for the hidden elements |
| endUser | toolBar.qDiscard | The discard button |
| endUser | toolBar.qSave | The save button |
| endUser | toolBar.qHideToolBar | The hide toolbar button |
| endUser | toolBar.qSwitchMode | The option to switch between Design and Interaction mode. Only available when a dashboard is published. |