Version: 9.4

Customization Submodules

Qrvey supports the customization of chart panels and floating menus within submodules.

Chart Panel

The following code sample shows how to remove the chart name from the chart panel’s header in a subModules configuration object.

"customization": {
  "subModules": {
    "chartPanel": {
      "remove": ["header.qChartName"]
    }
  }
}

The following code sample shows how to customize the menu layout displayed for a chart panel in a submodules configuration object. Options include "header" (default) and "floating". You can add this customization for the design, preview, and endUser views.

"customization": {
  "subModules": {
    "chartPanel": {
      "default": {},
      "menuLayout": "header",
      "remove": [...],
      "keep": [...]
    }
  }
}

Customization Keys

Header Options

Use the following options to customize the chart header.

Key	Description
`header`	Entire header for the panel.
`header.qChartName`	Title of the panel.
`header.qFitPanel`	Fit-to-panel button.
`header.qSorting`	Sorting button.
`header.qChartSelection`	Chart selection button.
`header.qFilter`	Filter and options for filtering.
`header.qFilter.qAddFilter`	Option to add a new filter.
`header.qFilter.dashFilterScope`	Option to display available options for filters with a dashboard scope. If you remove this option, its child edit and delete options are hidden.
`header.qFilter.dashFilterScope.qEditFilter`	Option to edit filters with a dashboard scope.
`header.qFilter.dashFilterScope.qDeleteFilter`	Option to delete filters with a dashboard scope.
`header.qFilter.tabFilterScope`	Option to display available options for filters with a tab scope. If you remove this option, its child edit and delete options are hidden.
`header.qFilter.tabFilterScope.qEditFilter`	Option to edit filters with a tab scope.
`header.qFilter.tabFilterScope.qDeleteFilter`	Option to delete filters with a tab scope.
`header.qFilter.panelFilterScope`	Option to display available options for filters with a panel scope. If you remove this option, its child edit and delete options are hidden.
`header.qFilter.panelFilterScope.qEditFilter`	Option to edit filters with a panel scope.
`header.qFilter.panelFilterScope.qDeleteFilter`	Option to delete filters with a panel scope.
`header.optionMenu`	Options (three-dot) menu.
`header.optionMenu.qEditChart`	Edit option inside the options menu.
`header.optionMenu.qDuplicateChart`	Duplicate option inside the options menu.
`header.optionMenu.qDownloadChart`	Download option inside the options menu.
`header.optionMenu.qDownloadChart.qChartJPG`	JPG format in the download option.
`header.optionMenu.qDownloadChart.qChartPDF`	PDF format in the download option.
`header.optionMenu.qDownloadChart.qChartCSV`	CSV format in the download option.
`header.optionMenu.qDownloadChart.qChartSummary`	CSV summary format in the download option.
`header.optionMenu.qDownloadChart.qChartExcel`	Excel format in the download option.
`header.qColumnGrouping`	Add/remove groups in a simple or grouped table.
`header.qColumnReplacement`	Column replacement section in column settings.
`header.qColumnSection`	Add/remove sections in an expandable table.
`header.qColumnSelection`	Add/remove columns in table charts.
`header.qColumnAggregation`	Column aggregation section in column settings.
`header.optionDateGrouping`	Column date grouping section in column settings.
`header.optionDateGrouping.qDayOnly`	Option for (Day Month) in date grouping dropdown.
`header.optionDateGrouping.qMonth`	Option for (Month, Year) in date grouping dropdown.
`header.optionDateGrouping.qMonthOnly`	Option for (Month) in date grouping dropdown.
`header.optionDateGrouping.qQuarter`	Option for (Quarter, Year) in date grouping dropdown.
`header.optionDateGrouping.qQuarterOnly`	Option for (Quarter) in date grouping dropdown.
`header.optionDateGrouping.qWeek`	Option for (Week, Year) in date grouping dropdown.
`header.optionDateGrouping.qYear`	Option for (Year) in date grouping dropdown.
`header.optionDateGrouping.qDay`	Option for (Full Date) in date grouping dropdown.
`header.optionDateGrouping.qHour`	Option for (Date, Hour) in date grouping dropdown.
`header.optionDateGrouping.qHourOnly`	Option for (Hour) in date grouping dropdown.
`header.optionDateGrouping.qMinute`	Option for (Date, Minute) in date grouping dropdown.
`header.optionDateGrouping.qMinuteOnly`	Option for (Minute) in date grouping dropdown.
`header.optionDateGrouping.qSecond`	Option for (Date, Second) in date grouping dropdown.
`header.optionDateGrouping.qSecondOnly`	Option for (Second) in date grouping dropdown.

Use the following options to display a floating menu for a chart rather than within the chart header (default). This menu becomes visible when the chart is selected.

Key	Description
`floatingMenu`	Entire floating menu for the panel.
`floatingMenu.qChartName`	Title of the panel.
`floatingMenu.qFitPanel`	Fit-to-panel button.
`floatingMenu.qSorting`	Sorting button.
`floatingMenu.qChartSelection`	Chart selection button.
`floatingMenu.qFilter`	Filter and options for filtering.
`floatingMenu.qFilter.qAddFilter`	Option to add a new filter.
`floatingMenu.qFilter.dashFilterScope`	Filters that apply to the entire dashboard.
`floatingMenu.qFilter.dashFilterScope.qEditFilter`	Option to edit a dashboard-level filter.
`floatingMenu.qFilter.dashFilterScope.qDeleteFilter`	Option to delete a dashboard-level filter.
`floatingMenu.qFilter.tabFilterScope`	Filters that apply to the current tab.
`floatingMenu.qFilter.tabFilterScope.qEditFilter`	Option to edit a tab-level filter.
`floatingMenu.qFilter.tabFilterScope.qDeleteFilter`	Option to delete a tab-level filter.
`floatingMenu.qFilter.panelFilterScope`	Filters that apply to the selected panel.
`floatingMenu.qFilter.panelFilterScope.qEditFilter`	Option to edit a panel-level filter.
`floatingMenu.qFilter.panelFilterScope.qDeleteFilter`	Option to delete a panel-level filter.
`floatingMenu.qEditChart`	Edit option inside the three-dot button.
`floatingMenu.qDuplicateChart`	Duplicate option inside the three-dot button.
`floatingMenu.qDownloadChart`	Download group inside the three-dot button.
`floatingMenu.qDownloadChart.qChartJPG`	JPG format in the download group.
`floatingMenu.qDownloadChart.qChartPDF`	PDF format in the download group.
`floatingMenu.qDownloadChart.qChartCSV`	CSV format in the download group.
`floatingMenu.qDownloadChart.qChartSummary`	CSV summary format in the download group.
`floatingMenu.qDownloadChart.qChartExcel`	Excel format in the download group.
`floatingMenu.qColumnReplacement`	Column replacement section in column settings.
`floatingMenu.qColumnGrouping`	Add/remove groups in a simple or grouped table.
`floatingMenu.qColumnSection`	Add/remove sections in an expandable table.
`floatingMenu.qColumnAggregation`	Column aggregation section in column settings.
`floatingMenu.qColumnSelection`	Add/remove columns in table charts.
`floatingMenu.optionDateGrouping`	Column date grouping section in column settings.
`floatingMenu.optionDateGrouping.qDayOnly`	Option for (Day Month) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qMonth`	Option for (Month, Year) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qMonthOnly`	Option for (Month) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qQuarter`	Option for (Quarter, Year) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qQuarterOnly`	Option for (Quarter) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qWeek`	Option for (Week, Year) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qYear`	Option for (Year) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qDay`	Option for (Full Date) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qHour`	Option for (Date, Hour) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qHourOnly`	Option for (Hour) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qMinute`	Option for (Date, Minute) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qMinuteOnly`	Option for (Minute) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qSecond`	Option for (Date, Second) in the date grouping dropdown.
`floatingMenu.optionDateGrouping.qSecondOnly`	Option for (Second) in the date grouping dropdown.

Example

"customization": {
  "subModules": {
    "chartPanel": {
      "default": {},
      "menuLayout": "header", // or "floating"
      "remove": [
        "floatingMenu.qSorting",
        "floatingMenu.qFitPanel"
      ],
      "keep": ["header.optionMenu.qDownloadChart.qChartPDF"]
    }
  }
}

Customization Submodules

Chart Panel

Menu Layout in a Chart Panel

Customization Keys

Header Options

Floating Menu Options

Example

Chart Panel​

Menu Layout in a Chart Panel​

Customization Keys​

Header Options​

Floating Menu Options​

Example​

Chart Panel

Menu Layout in a Chart Panel

Customization Keys

Header Options

Floating Menu Options

Example