survey-analytics
Version:
SurveyJS Dashboard is a UI component for visualizing and analyzing survey data. It interprets the form JSON schema to identify question types and renders collected responses using interactive charts and tables.
68 lines (67 loc) • 2.8 kB
TypeScript
/**
* An interface that describes a visualization item (chart, gauge, etc.).
*
* To access `IVisualizerPanelElement` objects, you can use the following properties and methods of `VisualizationPanel`:
*
* - [`getElements()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#getElements)
* - [`visibleElements`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#visibleElements)
* - [`hiddenElements`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#hiddenElements)
*/
export interface IVisualizerPanelElement {
/**
* The name of a survey question visualized by this item.
*/
name: string;
/**
* The title of a survey question visualized by this item. The visualization item displays the same title.
*/
displayName: string;
/**
* Indicates whether the visualization item is currently visible.
*
* If you want to disallow users to hide visualization items, set the [`allowHideQuestions`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizationpaneloptions#allowHideQuestions) property to `false`.
*/
isVisible: boolean;
isPublic: boolean;
/**
* Indicates the selected chart type.
*
* Possible values:
*
* - `"bar"`
* - `"vbar"`
* - `"stackedbar"`
* - `"pie"`
* - `"doughnut"`
* - `"gauge"`
* - `"bullet"`
* - `"radar"`
*/
chartType?: string;
/**
* Indicates the answer order in [bar charts](https://surveyjs.io/dashboard/documentation/chart-types#bar-chart), [histograms](https://surveyjs.io/dashboard/documentation/chart-types#histogram), and [statistics tables](https://surveyjs.io/dashboard/documentation/chart-types#statistics-table).
*
* Possible values:
*
* - `"default"` - Answers retain the initial sort order.
* - `"asc"` - Answers are sorted by ascending answer count.
* - `"desc"` - Answers are sorted by descending answer count.
*/
answersOrder?: string;
/**
* Indicates whether answers with zero count are hidden in [bar charts](https://surveyjs.io/dashboard/documentation/chart-types#bar-chart), [histograms](https://surveyjs.io/dashboard/documentation/chart-types#histogram), and [statistics tables](https://surveyjs.io/dashboard/documentation/chart-types#statistics-table).
*/
hideEmptyAnswers?: boolean;
/**
* Indicates whether the visualization item displays top 5, 10, or 20 answers by answer count. This property equals -1 if the Top N Answers feature is disabled.
*/
topN?: number;
}
export interface IState {
locale?: string;
elements?: IVisualizerPanelElement[];
}
export interface IPermission {
name: string;
isPublic: boolean;
}