survey-analytics 1.9.83 → 1.9.85

package/package.json

@@ -13,13 +13,14 @@
     "watch:dev": "webpack --env.buildType dev --watch",
     "build:dev": "webpack --env.buildType dev",
     "build:prod": "npm run build:dev && webpack --env.buildType prod",
+    "build": "npm run build:prod",
     "build:types:summary": "tsc --p tsconfig.summary.json && echo \"declare module 'survey-analytics' { import main = require('entries/summary'); export = main; }\" >> packages/survey.analytics.d.ts",
     "build:types:datatables": "tsc --p tsconfig.datatables.json && echo \"declare module 'survey-analytics/survey.analytics.datatables' { import main = require('entries/datatables'); export = main; }\" >> packages/survey.analytics.datatables.d.ts",
     "build:types:tabulator": "tsc --p tsconfig.tabulator.json && echo \"declare module 'survey-analytics/survey.analytics.tabulator' { import main = require('entries/tabulator'); export = main; }\" >> packages/survey.analytics.tabulator.d.ts",
     "lint": "eslint ./src --quiet",
     "pre-push-check": "npm run lint && npm run test"
   },
-  "version": "1.9.83",
+  "version": "1.9.85",
   "name": "survey-analytics",
   "description": "SurveyJS analytics Library.",
   "main": "survey.analytics.js",
@@ -71,7 +72,7 @@
     "jquery": "3.5.0",
     "muuri": "^0.8.0",
     "plotly.js-dist-min": "^2.11.1",
-    "survey-core": "1.9.83",
+    "survey-core": "1.9.85",
     "tabulator-tables": "4.8.4",
     "wordcloud": "^1.2.2"
   },

package/survey.analytics.css

@@ -1,5 +1,5 @@
 /*!
- * surveyjs - SurveyJS Dashboard library v1.9.83
+ * surveyjs - SurveyJS Dashboard library v1.9.85
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ  - http://surveyjs.io/
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
  */

package/survey.analytics.d.ts

@@ -770,20 +770,28 @@ declare module "visualizerBase" {
     import { IDataInfo, DataProvider } from "dataProvider";
     import { Event } from "survey-core";
     /**
-     * VisualizerBase is a base object for all visuzlizers. It responsible for the rendering and destroying visualizer.
+     * A base object for all visualizers. Use it to implement a custom visualizer.
      *
-     * constructor parameters:
-     * question - a survey question to visualize,
-     * data - an array of answers in format of survey result,
-     * options - object with the following options,
-     * name - visualizer name
+     * Constructor parameters:
      *
-     * options:
-     * seriesValues - an array of series values in data to group data by series,
-     * seriesLabels - labels for series to display, if not passed the seriesValues are used as labels,
-     * survey - pass survey instance to use localses from the survey JSON,
-     * dataProvider - dataProvider for this visualizer,
+     * - `question`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * A survey question to visualize.
+     * - `data`: `Array<any>`\
+     * Survey results.
+     * - `options`\
+     * An object with the following properties:
+     *    - `seriesValues`: `Array<String>`\
+     *    Series values used to group data.
+     *    - `seriesLabels`: `Array<String>`\
+     *    Series labels to display. If this property is not set, `seriesValues` are used as labels.
+     *    - `survey`: [`SurveyModel`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model)\
+     *    Pass a `SurveyModel` instance if you want to use locales from the survey JSON schema.
+     *    - `dataProvider`: `DataProvider`\
+     *    A data provider for this visualizer.
+     * - `name`: `String`\
+     * *(Optional)* The visualizer's name.
      *
+     * [View Demo](https://surveyjs.io/dashboard/examples/how-to-plot-survey-data-in-custom-bar-chart/ (linkStyle))
      */
     export class VisualizerBase implements IDataInfo {
         question: Question;
@@ -803,14 +811,31 @@ declare module "visualizerBase" {
         protected _supportSelection: boolean;
         static otherCommentCollapsed: boolean;
         /**
-         * The event is fired right after a visualizer's content is rendered in DOM.
+         * An event that is raised after the visualizer's content is rendered.
+         *
+         * Parameters:
+         *
+         * - `sender`: `VisualizerBase`\
+         * A `VisualizerBase` instance that raised the event.
+         *
+         * - `options.htmlElement`: `HTMLElement`\
+         * A page element with the visualizer's content.
+         * @see render
+         * @see refresh
          **/
         onAfterRender: Event<(sender: VisualizerBase, options: any) => any, VisualizerBase, any>;
         protected afterRender(contentContainer: HTMLElement): void;
         /**
-         * Fires when visualizer locale changed.
-         * sender - this visualizer
-         * locale - new locale of the visualizer
+         * An event that is raised after a new locale is set.
+         *
+         * Parameters:
+         *
+         * - `sender`: `VisualizerBase`\
+         * A `VisualizerBase` instance that raised the event.
+         *
+         * - `options.locale`: `String`\
+         * The indentifier of a new locale (for example, "en").
+         * @see locale
          */
         onLocaleChanged: Event<(sender: VisualizerBase, options: {
             locale: string;
@@ -824,68 +849,54 @@ declare module "visualizerBase" {
             [index: string]: any;
         }, _name?: string);
         protected get questionOptions(): any;
-        /**
-         * This method is called then data has been changed for some reason, e.g. filter was set.
-         * This method should be overriden if descendant computes own statistics or process data somehow.
-         */
         protected onDataChanged(): void;
-        /**
-         * Name of the data field of data object from the data array.
-         */
         get dataName(): string | Array<string>;
         /**
-         * Indicates whether visualizer has header. Usually it is true then a question has correct answer.
+         * Indicates whether the visualizer displays a header. This property is `true` when a visualized question has a correct answer.
+         * @see hasFooter
          */
         get hasHeader(): boolean;
         /**
-         * Indicates whether visualizer has footer. Usually it is true then a question has comment or choices question has other item.
+         * Indicates whether the visualizer displays a footer. This property is `true` when a visualized question has a comment.
+         * @see hasHeader
          */
         get hasFooter(): boolean;
         protected createVisualizer<T = VisualizerBase>(question: Question): T;
         /**
-         * Footer visualizer getter.
+         * Allows you to access the footer visualizer. Returns `undefined` if the footer is absent.
+         * @see hasFooter
          */
         get footerVisualizer(): VisualizerBase;
         /**
-         * Indicates whether visualizer supports selection. Visualizers of questions with choices allow to select choice by clicking on the diagram bar and filter other data for the selected item.
+         * Indicates whether users can select series points to cross-filter charts. To allow or disallow selection, set the `allowSelection` property of the `options` object in the constructor.
          */
         get supportSelection(): boolean;
-        /**
-         * Series values getter. Some questions (used in matrices) should be grouped by matrix rows. This groups are called series.
-         */
         getSeriesValues(): Array<string>;
-        /**
-         * Series labels getter. Some questions (used in matrices) should be grouped by matrix rows. This groups are called series.
-         */
         getSeriesLabels(): Array<string>;
-        /**
-         * Available values of question answers (available choices).
-         */
         getValues(): Array<any>;
-        /**
-         * Available labels of question answers (human readable representation of available choices).
-         */
         getLabels(): Array<string>;
         /**
-         * Registers creator of visualizer toolbar item.
+         * Registers a function used to create a toolbar item for this visualizer.
+         * @param name A custom name for the toolbar item.
+         * @param creator A function that accepts the toolbar and should return an `HTMLElement` with the toolbar item.
          */
         registerToolbarItem(name: string, creator: (toolbar?: HTMLDivElement) => HTMLElement): void;
         /**
-         * The name of the visaulizer.
+         * Returns the visualizer's name.
          */
         get name(): string;
         /**
-         * The actual data of the visaulizer.
+         * Returns an array of survey results used to calculate values for visualization. If a user applies a filter, the array is also filtered.
+         *
+         * To get an array of calculated and visualized values, call the [`getData()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#getData) method.
          */
         protected get data(): {
             [index: string]: any;
         }[];
-        /**
-         * The data provider is used by the visaulizer.
-         */
         protected get dataProvider(): DataProvider;
         /**
-         * Updates visualizer data.
+         * Updates visualized data.
+         * @param data A data array with survey results to be visualized.
          */
         updateData(data: Array<{
             [index: string]: any;
@@ -893,57 +904,33 @@ declare module "visualizerBase" {
         onUpdate: () => void;
         invokeOnUpdate(): void;
         /**
-         * Destroys visualizer.
+         * Deletes the visualizer and all its elements from the DOM.
+         * @see clear
          */
         destroy(): void;
         /**
-         * Method for clearing all rendered elements from outside.
+         * Empties the toolbar, footer, and content containers.
+         *
+         * If you want to empty and delete the visualizer and all its elements from the DOM, call the [`destroy()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#destroy) method instead.
          */
         clear(): void;
         protected createToolbarItems(toolbar: HTMLDivElement): void;
         protected getCorrectAnswerText(): string;
-        /**
-         * Destroys visualizer toolbar.
-         */
         protected destroyToolbar(container: HTMLElement): void;
-        /**
-         * Renderss visualizer toolbar.
-         */
         protected renderToolbar(container: HTMLElement): void;
-        /**
-         * Destroys visualizer header.
-         * Usually overriden in descendants.
-         */
         protected destroyHeader(container: HTMLElement): void;
-        /**
-         * Destroys visualizer content.
-         * Usually overriden in descendants.
-         */
         protected destroyContent(container: HTMLElement): void;
-        /**
-         * Renders visualizer header.
-         * Usually overriden in descendants.
-         */
         protected renderHeader(container: HTMLElement): void;
-        /**
-         * Renders visualizer content.
-         * Usually overriden in descendants.
-         */
         protected renderContent(container: HTMLElement): void;
-        /**
-         * Destroys visualizer footer.
-         */
         protected destroyFooter(container: HTMLElement): void;
-        /**
-         * Renders visualizer footer.
-         */
         protected renderFooter(container: HTMLElement): void;
         /**
-         * Renders visualizer in the given container.
+         * Renders the visualizer in a specified container.
+         * @param targetElement An `HTMLElement` or an `id` of a page element in which you want to render the visualizer.
          */
         render(targetElement: HTMLElement | string): void;
         /**
-         * Redraws visualizer and all inner content.
+         * Re-renders the visualizer and its content.
          */
         refresh(): void;
         protected processText(text: string): string;
@@ -956,23 +943,42 @@ declare module "visualizerBase" {
         static customColors: string[];
         private static colors;
         getColors(count?: number): any;
+        /**
+         * Gets or sets the visibility of the visualizer's toolbar.
+         *
+         * Default value: `true`
+         */
         get showHeader(): boolean;
         set showHeader(newValue: boolean);
         /**
-         * Returns data to be used in the visualizer.
+         * Returns an array of calculated and visualized values. If a user applies a filter, the array is also filtered.
+         *
+         * To get an array of source survey results, use the [`data`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#data) property.
          */
         getData(): any;
+        /**
+         * Returns an object with properties that describe a current visualizer state. The properties are different for each individual visualizer.
+         *
+         * > This method is overriden in descendant classes.
+         * @see setState
+         */
         getState(): any;
-        setState(state: any): void;
         /**
-         * Returns current locale of the visualizer.
-         * If locales more than one, the language selection dropdown will be added in the toolbar
-         * In order to use survey locales the survey instance object should be passed as 'survey' option for visualizer
+         * Sets the visualizer's state.
+         *
+         * > This method is overriden in descendant classes.
+         * @see getState
          */
-        get locale(): string;
+        setState(state: any): void;
         /**
-         * Sets locale for visualization panel.
+         * Gets or sets the current locale.
+         *
+         * If you want to inherit the locale from a visualized survey, assign a `SurveyModel` instance to the `survey` property of the `options` object in the constructor.
+         *
+         * If the survey is [translated into more than one language](https://surveyjs.io/form-library/examples/survey-localization/), the toolbar displays a language selection drop-down menu.
+         * @see onLocaleChanged
          */
+        get locale(): string;
         set locale(newLocale: string);
         protected setLocale(newLocale: string): void;
     }
@@ -1042,7 +1048,12 @@ declare module "selectBase" {
             [index: string]: any;
         }>, options?: any, name?: string);
         protected chartTypes: string[];
-        chartType: string;
+        protected _chartType: string;
+        /**
+         * Chart type - current chart type.
+         */
+        get chartType(): string;
+        set chartType(newChartType: string);
         private updateEmptyAnswersBtn;
         private updateTransposeDataBtn;
         private updateOrderSelector;
@@ -1055,19 +1066,37 @@ declare module "selectBase" {
         getSelectedItemByText(itemText: string): any;
         setSelection(item: ItemValue): void;
         get selection(): ItemValue;
+        /**
+         * Gets and sets whether chart should show percentages only.
+         */
         get showOnlyPercentages(): boolean;
         set showOnlyPercentages(val: boolean);
+        /**
+         * Gets and sets whether chart should show values and percentages.
+         */
         get showPercentages(): boolean;
         set showPercentages(val: boolean);
+        /**
+         * Gets and sets chart elements order.
+         */
         get answersOrder(): string;
         set answersOrder(value: string);
+        /**
+         * Set to true if need to hide empty chart elements (e.g. bars vith zero value).
+         */
         get hideEmptyAnswers(): boolean;
         set hideEmptyAnswers(value: boolean);
         get transposeData(): boolean;
         set transposeData(value: boolean);
+        /**
+         * Set to some value if need to show top N chart elements.
+         */
         get topN(): number;
         set topN(value: number);
         protected isSupportMissingAnswers(): boolean;
+        /**
+         * Set to true if you want to see chart elements for missing answers (e.g. radiogroup items never been selected by surveyee).
+         */
         get showMissingAnswers(): boolean;
         set showMissingAnswers(value: boolean);
         refreshContent(): void;
@@ -1120,7 +1149,6 @@ declare module "boolean" {
     import { SelectBase } from "selectBase";
     export class BooleanModel extends SelectBase {
         protected chartTypes: string[];
-        chartType: string;
         constructor(question: Question, data: Array<{
             [index: string]: any;
         }>, options?: Object, name?: string);
@@ -1143,7 +1171,6 @@ declare module "histogram" {
         private _cachedIntervals;
         private _intervalPrecision;
         protected chartTypes: string[];
-        chartType: string;
         static IntervalsCount: number;
         static UseIntervalsFrom: number;
         constructor(question: Question, data: Array<{
@@ -1223,7 +1250,6 @@ declare module "config" {
         displayName: string;
         isVisible: boolean;
         isPublic: boolean;
-        type?: string;
         chartType?: string;
         answersOrder?: string;
         hideEmptyAnswers?: boolean;
@@ -1252,6 +1278,10 @@ declare module "filterInfo" {
     }
 }
 declare module "layoutEngine" {
+    /**
+     * LayoutEngine controls visualizer layoput in a visualization panel.
+     * You can create a descendant of this class in order to override layout.
+     */
     export class LayoutEngine {
         protected _allowed: boolean;
         constructor(_allowed: boolean);
@@ -1259,8 +1289,17 @@ declare module "layoutEngine" {
         protected stopCore(): void;
         protected updateCore(): void;
         get allowed(): boolean;
+        /**
+         * Initilizes layout engine in the given HTML element.
+         */
         start(container: HTMLElement): void;
+        /**
+         * Deactivates layouting: stops elements auto-positioning
+         */
         stop(): void;
+        /**
+         * Updates layout: performs elements auto-positioning
+         */
         update(): void;
         add(elements: Array<HTMLElement>, options?: any): void;
         remove(elements: Array<HTMLElement>, options?: any): void;
@@ -1293,7 +1332,11 @@ declare module "visualizationPanel" {
      * Visualization Panel configuration. Pass it as the third argument to the `VisualizationPanel` constructor:
      *
      * ```js
-     * const vizPanel = new SurveyAnalytics.VisualizationPanel(surveyQuestions, surveyResults, vizPanelOptions);
+     * const vizPanel = new SurveyAnalytics.VisualizationPanel(
+     *   surveyQuestions,
+     *   surveyResults,
+     *   vizPanelOptions
+     * );
      * ```
      */
     export interface IVisualizationPanelOptions {
@@ -1613,9 +1656,6 @@ declare module "visualizationPanel" {
          * Fires when permissions changed
          */
         onPermissionsChangedCallback: any;
-        /**
-         * Renders given panel element.
-         */
         protected renderPanelElement(element: IVisualizerPanelRenderedElement, container: HTMLElement): HTMLElement;
         protected renderToolbar(container: HTMLElement): void;
         /**
@@ -1623,9 +1663,6 @@ declare module "visualizationPanel" {
          * container - HTML element to render the panel
          */
         renderContent(container: HTMLElement): void;
-        /**
-         * Destroys visualizer and all inner content.
-         */
         protected destroyContent(container: HTMLElement): void;
         /**
          * Redraws visualizer toobar and all inner content.

package/survey.analytics.datatables.css

@@ -1,5 +1,5 @@
 /*!
- * surveyjs - SurveyJS Dashboard library v1.9.83
+ * surveyjs - SurveyJS Dashboard library v1.9.85
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ  - http://surveyjs.io/
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
  */

package/survey.analytics.datatables.js

@@ -1,5 +1,5 @@
 /*!
- * surveyjs - SurveyJS Dashboard library v1.9.83
+ * surveyjs - SurveyJS Dashboard library v1.9.85
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ  - http://surveyjs.io/
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
  */

package/survey.analytics.datatables.min.css

@@ -1,5 +1,5 @@
 /*!
- * surveyjs - SurveyJS Dashboard library v1.9.83
+ * surveyjs - SurveyJS Dashboard library v1.9.85
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ  - http://surveyjs.io/
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
  */

package/survey.analytics.datatables.min.js

@@ -1,5 +1,5 @@
 /*!
- * surveyjs - SurveyJS Dashboard library v1.9.83
+ * surveyjs - SurveyJS Dashboard library v1.9.85
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ  - http://surveyjs.io/
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
  */