IDashboardOptions API Reference

A configuration object passed to the Dashboard constructor.

Inherited from the following class(es):

IVisualizationPanelOptions ISelectBaseVisualizerOptions

allowChangeAnswersOrder allowChangeVisualizerType allowDragDrop allowDynamicLayout allowHideEmptyAnswers allowHideQuestions allowSelection allowShowMissingAnswers allowShowPercentages allowSortAnswers allowTopNAnswers allowTransposeData answersOrder availableDatePeriods data dateFieldName datePeriod dateRange hideEmptyAnswers items labelTruncateLength layoutEngine legendPosition percentagePrecision questions showDatePanel showOnlyPercentages showPercentages showToolbar stripHtmlFromTitles survey

allowChangeAnswersOrder property

Obsolete. Use the allowSortAnswers property instead.

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

allowChangeVisualizerType property

Enables switching between different visualizer types.

Default value: true

Type:: boolean readonly

Implemented in:: IVisualizationPanelOptions

allowDragDrop property

Enables drag-and-drop reordering of dashboard items. Applies only if allowDynamicLayout is true.

Default value: true

Type:: boolean readonly

Implemented in:: IVisualizationPanelOptions

See also:: layoutEngine

allowDynamicLayout property

Enables automatic layout based on available screen space and allows users to reorder items via drag and drop.

If disabled, items are rendered sequentially (one below another), and drag-and-drop reordering is disabled. To disable only drag-and-drop while keeping dynamic layout, set allowDragDrop to false.

Default value: true

How to Disable the Layout Engine

Type:: boolean readonly

Implemented in:: IVisualizationPanelOptions

See also:: layoutEngine

allowHideEmptyAnswers property

Enables hiding answers with zero responses in bar charts, histograms, and statistics tables. Adds a Hide Empty Answers button to each supported visualizer.

Default value: false

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

allowHideQuestions property

Enables users to hide individual dashboard items. Adds a Hide button to each item.

Default value: true

Type:: boolean readonly

Implemented in:: IVisualizationPanelOptions

allowSelection property

Enables cross-filtering between dashboard items. When enabled, selecting a data point filters other dashboard items accordingly.

Default value: true

Type:: boolean readonly

Implemented in:: IVisualizationPanelOptions

allowShowMissingAnswers property

Enables displaying the number of respondents who skipped a question. Adds a Show Missing Answers button to each chart.

Default value: false

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

allowShowPercentages property

Allows users to toggle between absolute values and percentages in bar charts. Adds a Show Percentages button to each bar chart.

Default value: false

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

See also:: showPercentages * , showOnlyPercentages * , percentagePrecision

allowSortAnswers property

Enables sorting answers by response count in bar charts, histograms, and statistics tables. Adds a Sorting dropdown to each supported dashboard item.

Default value: true

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

See also:: answersOrder

allowTopNAnswers property

Enables selection of top 5, 10, or 20 answers by response count. Adds a Top N Answers dropdown to each chart.

Default value: false

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

allowTransposeData property

Enables transposing data for matrix question visualizations.

Adds a Transpose button to supported charts.

Per Values – Matrix rows become chart arguments, columns become series.
Per Columns – Matrix rows become series, columns become arguments.

Default value: false

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

answersOrder property

Specifies the answer sorting order in bar charts, histograms, and statistics tables.

Accepted values:

"default" (default) – Preserve original order.
"asc" – Sort by ascending response count.
"desc" – Sort by descending response count.

Users can modify this setting in the UI if allowSortAnswers is enabled.

Type:: "default" | "asc" | "desc" readonly

Implemented in:: ISelectBaseVisualizerOptions

availableDatePeriods property

An array of date periods available for selection in the date panel.

Refer to datePeriod for supported values.

Type:: DatePeriodEnum[] readonly

Implemented in:: IDashboardOptions

data property

An array of survey response objects to visualize.

In addition to data, specify at least one of the following:

questions
Dashboard items are generated automatically based on question settings.
items
Dashboard items are defined explicitly.
Both questions and items
Items are generated from questions and then customized using items.

Type:: any[] readonly

Implemented in:: IDashboardOptions

dateFieldName property

The name of a data field that contains date values used by the date panel.

Type:: string readonly

Implemented in:: IDashboardOptions

datePeriod property

The predefined date period selected in the date panel. Applies only if dateFieldName is specified.

Supported values:

"last7days"
"last14days"
"last28days"
"last30days"
"lastWeekSun"
"lastWeekMon"
"lastMonth"
"lastQuarter"
"lastYear"
"ytd"
"mtd"
"wtdSun"
"wtdMon"
"qtd"

Type:: "last7days" | "last14days" | "last28days" | "last30days" | "lastWeekMon" | "lastWeekSun" | "lastMonth" | "lastQuarter" | "lastYear" | "ytd" | "mtd" | "wtdSun" | "wtdMon" | "qtd" readonly

Implemented in:: IDashboardOptions

See also:: availableDatePeriods * , showDatePanel

dateRange property

A [startDate, endDate] tuple that defines a custom date range. Applies only if dateFieldName is specified.

If both datePeriod and dateRange are specified, dateRange takes precedence.

Type:: DateRangeTuple readonly

Implemented in:: IDashboardOptions

hideEmptyAnswers property

Hides answers with zero responses in bar charts, histograms, and statistics tables.

Default value: false

Users can modify this setting in the UI if allowHideEmptyAnswers is enabled.

Type:: boolean readonly

Implemented in:: ISelectBaseVisualizerOptions

items property

An array of data field names and dashboard item configuration objects.

Specify this property to define dashboard items explicitly or customize items generated from the questions array. The array order determines the item order in the Dashboard.

Type:: (string | IDashboardItemOptions)[] readonly

Implemented in:: IDashboardOptions

labelTruncateLength property

Maximum label length before truncation starts. Set to -1 to disable truncation.

Default value: 27

Type:: number readonly

Implemented in:: IVisualizationPanelOptions

layoutEngine property

A layout engine implementation used to arrange dashboard items. Use this property to integrate a third-party layout engine.

Type:: LayoutEngine readonly

Implemented in:: IVisualizationPanelOptions

See also:: allowDynamicLayout

legendPosition property

Default chart legend position.

You can override this setting per dashboard item using the items array.

Type:: "left" | "right" | "top" | "bottom" readonly

Implemented in:: ISelectBaseVisualizerOptions

percentagePrecision property

Number of decimal places used when displaying percentages.

Default value: 2

Type:: number readonly

Implemented in:: ISelectBaseVisualizerOptions

See also:: allowShowPercentages * , showPercentages * , showOnlyPercentages

questions property

An array of survey questions to visualize.

To populate this array, instantiate a SurveyModel, call its getAllQuestions() method, optionally filter the result, and assign it to this property.

When questions are specified, the Dashboard generates items automatically according to question configuration. Use the items array to customize the generated items.