survey-analytics 1.9.31 → 1.9.32

package/package.json

@@ -6,7 +6,7 @@
     "test_debug": "node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand",
     "testcafe": "concurrently \"http-server\" \"testcafe chrome testCafe/\"",
     "testcafe_ci": "http-server --silent & testcafe chrome:headless testCafe/ --reporter minimal,dashboard",
-    "testcafe_file": "concurrently \"http-server --silent\" \"testcafe chrome testCafe/summary/basetests.js --selector-timeout 1500 --reporter minimal --debug-mode\"",
+    "testcafe:file": "concurrently \"http-server --silent\" \"testcafe chrome testCafe/tabulator/basetests.js --selector-timeout 1500 --reporter minimal --debug-mode\"",
     "release": "standard-version --message \"Release: %s [skip ci]\" ",
     "doc_gen": "node doc_generator/lib_docgenerator.js src/index.ts",
     "doc_update": "chmod +x ./docupdate_npm.sh && ./docupdate_npm.sh",
@@ -16,7 +16,7 @@
     "lint": "eslint ./src --quiet",
     "pre-push-check": "npm run lint && npm run test"
   },
-  "version": "1.9.31",
+  "version": "1.9.32",
   "name": "survey-analytics",
   "description": "SurveyJS analytics Library.",
   "main": "survey.analytics.js",

package/survey.analytics.css

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

package/survey.analytics.d.ts

@@ -1,4 +1,4 @@
-/*Type definitions for SurveyJS Analytics library v1.9.31
+/*Type definitions for SurveyJS Analytics library v1.9.32
 Copyright (c) 2015-2022 Devsoft Baltic OÜ  - http://surveyjs.io/
 Definitions by: Devsoft Baltic OÜ <https://github.com/surveyjs/>
 */
@@ -8,10 +8,10 @@ Definitions by: Devsoft Baltic OÜ <https://github.com/surveyjs/>
 
 import { Event } from "survey-core";
 import { Question } from "survey-core";
+import { SurveyModel } from "survey-core";
 import { IQuestion } from "survey-core";
 import { QuestionMatrixDropdownModel } from "survey-core";
 import { ItemValue } from "survey-core";
-import { SurveyModel } from "survey-core";
 import Plotly from "plotly.js-dist-min";
 import { QuestionMatrixModel } from "survey-core";
 import { QuestionBooleanModel } from "survey-core";
@@ -292,7 +292,7 @@ export class VisualizerBase implements IDataInfo {
         /**
             * Renders visualizer in the given container.
             */
-        render(targetElement: HTMLElement): void;
+        render(targetElement: HTMLElement | string): void;
         /**
             * Redraws visualizer and all inner content.
             */
@@ -357,25 +357,131 @@ import "./visualizationPanel.scss";
 export interface IVisualizerPanelRenderedElement extends IVisualizerPanelElement {
         renderedElement?: HTMLElement;
 }
+/**
+    * This interface contains all available options to setup a visualization panel
+    */
+export interface IVisualizationPanelOptions {
+        /**
+            * Set the length of a label where the truncation starts. Set to -1 to disable truncate. Default is 27
+            */
+        labelTruncateLength?: number;
+        /**
+            * Set it to true to allow make elements private/public also @see persmissions property
+            */
+        allowMakeQuestionsPrivate?: boolean;
+        /**
+            * An array of series values in data to group data by series
+            */
+        seriesValues?: string[];
+        /**
+            * Labels for series to display, if not passed the seriesValues are used as labels
+            */
+        seriesLabels?: string[];
+        /**
+            * Set it to true to force use values as labels
+            */
+        useValuesAsLabels?: boolean;
+        /**
+            * Pass survey instance to use localses from the survey JSON
+            */
+        survey?: SurveyModel;
+        /**
+            * dataProvider instance for this visualizer
+            */
+        dataProvider?: DataProvider;
+        /**
+            * Set it to false to deny user to hide/show individual questions, this will hide the corresponding question toolbar button
+            */
+        allowHideQuestions?: boolean;
+        /**
+            * Set it to false to disable items drag/drop reordering and dynamic layouting
+            */
+        allowDynamicLayout?: boolean;
+        /**
+            * Layout engine to be used for layouting inner visualizers @see LayoutEngine
+            */
+        layoutEngine?: LayoutEngine;
+        /**
+            * Set to true to allow to show percentages in bar charts, this will show the corresponding question toolbar button
+            */
+        allowShowPercentages?: boolean;
+        /**
+            * Set it to true to show percentages in bar charts
+            */
+        showPercentages?: boolean;
+        /**
+            * Set it to true to show percentages only in bar charts (don't show values)
+            */
+        showOnlyPercentages?: boolean;
+        /**
+            * Set percentage decimal presision
+            */
+        percentagePrecision?: number;
+        /**
+            *
+            */
+        haveCommercialLicense?: boolean;
+        /**
+            * Set to true to allow change answers order, choices are ordered by answers count, this will show the corresponding question toolbar dropdown
+            */
+        allowChangeAnswersOrder?: boolean;
+        /**
+            * Defauls answers order
+            */
+        answersOrder?: "default" | "desc" | "desc";
+        /**
+            * Set to true to allow hide empty answers, this will show the corresponding question toolbar button
+            */
+        allowHideEmptyAnswers?: boolean;
+        /**
+            * Set to true to hide empty answers
+            */
+        hideEmptyAnswers?: boolean;
+        /**
+            * Set to true to allow show top N answers, this will show the corresponding question toolbar dropdown
+            */
+        allowTopNAnswers?: boolean;
+        /**
+            * Set to true to allow show missing answers, this will show the corresponding question toolbar button
+            */
+        allowShowMissingAnswers?: boolean;
+        /**
+            * Set to true to allow to use experimental features: e.g. vertical bar chart configuration
+            */
+        allowExperimentalFeatures?: boolean;
+        /**
+            * Set default chart type
+            */
+        defaultChartType?: string;
+        /**
+            * Set to true to allow transpose data: answers in matrix can be grouped by columns or by rows, this will show the corresponding question toolbar button
+            */
+        allowTransposeData?: boolean;
+        /**
+            * Set to false to disable selection and cross filtering in charts
+            */
+        allowSelection?: boolean;
+        /**
+            * Pass a function to render content of a visualizer
+            */
+        renderContent?: Function;
+        /**
+            * Pass a function to destroy content of a visualizer
+            */
+        destroyContent?: Function;
+        /**
+            * Set to true to strip HTML tags from titles
+            */
+        stripHtmlFromTitles?: boolean;
+}
 /**
     * VisualizationPanel is responsible for visualizing an array of survey questions
-    *
-    * constructor parameters:
-    * questions - an array of survey questions to visualize,
-    * data - an array of answers in format of survey result,
-    * options - object with the following options,
-    * elements - list of visual element descriptions
-    *
-    * options:
-    * allowDynamicLayout - set it to false to disable items drag/drop reordering and dynamic layouting,
-    * labelTruncateLength - the length of the label where the truncation starts. Set to -1 to disable truncate. Default is 27.
-    * allowHideQuestions - set it to false to deny user to hide/show individual questions,
-    * allowMakeQuestionsPrivate - set it to true to allow make elements private/public also see persmissions property,
-    * 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,
-    * layoutEngine - layout engine to be used for layouting inner visualizers
+    * <br/>
+    * <br/> constructor parameters:
+    * <br/> questions - an array of survey questions to visualize,
+    * <br/> data - an array of answers in format of survey result,
+    * <br/> options - object of the IVisualizationPanelOptions type, @see IVisualizationPanelOptions
+    * <br/> elements - list of visual element descriptions
     *
     */
 export class VisualizationPanel extends VisualizerBase {
@@ -384,9 +490,7 @@ export class VisualizationPanel extends VisualizerBase {
         visualizers: Array<VisualizerBase>;
         constructor(questions: Array<any>, data: Array<{
                 [index: string]: any;
-        }>, options?: {
-                [index: string]: any;
-        }, _elements?: Array<IVisualizerPanelRenderedElement>);
+        }>, options?: IVisualizationPanelOptions, _elements?: Array<IVisualizerPanelRenderedElement>);
         protected showElement(elementName: string): void;
         protected hideElement(elementName: string): void;
         protected makeElementPrivate(element: IVisualizerPanelElement): void;
@@ -607,7 +711,7 @@ export class DataTables extends Table {
     setPageSize(value: number): void;
     setPageNumber(value: number): void;
     getPageNumber(): number;
-    render(targetNode: HTMLElement): void;
+    render(targetNode: HTMLElement | string): void;
     getColumns(): Array<any>;
     layout(): void;
 }
@@ -641,7 +745,7 @@ export class Tabulator extends Table {
     static set haveCommercialLicense(val: boolean);
     constructor(survey: SurveyModel, data: Array<Object>, options: ITabulatorOptions, _columns?: Array<any>);
     tabulatorTables: any;
-    render(targetNode: HTMLElement): void;
+    render(targetNode: HTMLElement | string): void;
     destroy: () => void;
     getColumns(): Array<any>;
     setColumnVisibility(columnName: string, isVisible: boolean): void;
@@ -862,7 +966,7 @@ export abstract class Table {
         abstract applyFilter(value: string): void;
         abstract applyColumnFilter(columnName: string, value: string): void;
         abstract sortByColumn(columnName: string, direction: string): void;
-        render(targetNode: HTMLElement): void;
+        render(targetNode: HTMLElement | string): void;
         enableColumnReorder(): void;
         disableColumnReorder(): void;
         getPageNumber(): number;
@@ -871,6 +975,7 @@ export abstract class Table {
         setPageSize(value: number): void;
         getCreatedRows(): TableRow[];
         clearCreatedRows(): void;
+        protected get useNamesAsTitles(): boolean;
         protected buildColumns: (survey: SurveyModel) => ITableColumn[];
         isColumnVisible(column: ITableColumn): boolean;
         get columns(): Array<ITableColumn>;

package/survey.analytics.datatables.css

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