IVisualizationPanelOptions
Visualization Panel configuration. Pass it as the third argument to the VisualizationPanel constructor:
import { VisualizationPanel } from "survey-analytics";
const vizPanel = new VisualizationPanel(
surveyQuestions,
surveyResults,
vizPanelOptions
);
Properties
Methods
Events
Allows users to sort answers by answer count. Applies only to bar and scatter charts.
This property adds a Sorting dropdown to each bar and scatter chart.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- answersOrder
Specifies whether users can drag and drop charts. Applies only if allowDynamicLayout is true.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- layoutEngine
Specifies whether to arrange charts based on the available screen space and allow users to reorder them via drag and drop.
If this property is disabled, charts are displayed one under another, and users cannot drag and drop them. If you want to disable only drag and drop, set the allowDragDrop property to false.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- layoutEngine
Allows users to hide answers with zero count in bar and scatter charts.
This property adds a Hide Empty Answers button to each bar and scatter chart.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
Allows users to change the visibility of individual charts.
This property adds a Hide button to each chart.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
Allows users to cross-filter charts. The filter applies when users select a series point.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
Allows users to show the number of respondents who did not answer a particular question.
This property adds a Show Missing Answers button to each chart.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
Allows users to switch between absolute and percentage values in bar charts.
This property adds a Show Percentages button to each bar chart.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- showPercentages * , showOnlyPercentages * , percentagePrecision
Allows users to select whether to show top 5, 10, or 20 answers by answer count.
This property adds a Top N Answers dropdown to each chart.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
Allows users to transpose a visualized matrix question.
This property adds a Transpose button to charts that visualize matrixes. When users select Per Values, matrix rows go to chart arguments and matrix columns form chart series. When users select Per Columns, matrix rows form chart series and matrix columns go to chart arguments.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
Specifies how to sort answers in bar and scatter charts.
Accepted values:
"default"(default) - Do not sort answers."asc"- Sort answers by ascending answer count."desc"- Sort answers by descending answer count.
Users can change this property value if you enable the allowChangeAnswersOrder property.
- Type:
- "default" | "asc" | "desc" readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- allowChangeAnswersOrder
A common data provider for all visualizers.
- Type:
- DataProvider readonly
- Implemented in:
- IVisualizationPanelOptions
Default chart type.
Accepted values depend on the question type as follows:
- Boolean:
"bar"|"pie"|"doughnut" - Date, Number:
"bar"|"scatter" - Matrix:
"bar"|"pie"|"doughnut"|"stackedbar" - Rating:
"bar"|"scatter"|"gauge"|"bullet" - Radiogroup, Checkbox, Dropdown, Image Picker:
"bar"|"pie"|"doughnut"|"scatter"
To set a type for an individual chart, access this chart in the visualizers array and set its chartType property to one of the values described above:
const vizPanel = new SurveyAnalytics.VisualizationPanel( ... );
vizPanel.visualizers[0].chartType = "stackedbar";
- Type:
- string readonly
- Implemented in:
- IVisualizationPanelOptions
Hides answers with zero count in bar and scatter charts.
Users can change this property value if you enable the allowHideEmptyAnswers property.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- allowHideEmptyAnswers
The number of label characters after which truncation starts.
Set this property to -1 to disable truncation.
Default value: 27
- Type:
- number readonly
- Implemented in:
- IVisualizationPanelOptions
A layout engine used to arrange charts on the Visualization Panel.
You can use this property to integrate a third-party layout engine with SurveyJS Dashboard.
- Type:
- LayoutEngine readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- allowDynamicLayout
Specifies percentage precision.
Default value: 0
- Type:
- number readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- allowShowPercentages * , showPercentages * , showOnlyPercentages
Specifies whether bar charts display only percentages, without absolute values.
Applies only if the allowShowPercentages or showPercentages property is enabled.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- allowShowPercentages * , showPercentages * , percentagePrecision
Specifies whether bar charts display percentages in addition to absolute values.
Users can change this property value if you enable the allowShowPercentages property.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
- See also:
- allowShowPercentages * , showOnlyPercentages * , percentagePrecision
Removes HTML tags from survey element titles.
Survey element titles can contain HTML markup and are specified by users. An attacker can inject malicious code into the titles. To guard against it, keep this property set to true.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- IVisualizationPanelOptions
Pass a survey instance to use survey locales in the Visualization Panel.
- Type:
- SurveyModel readonly
- Implemented in:
- IVisualizationPanelOptions
Copyright © 2024 Devsoft Baltic OÜ. All rights reserved.