survey-analytics 1.11.4 → 1.11.5

package/package.json

@@ -20,7 +20,7 @@
     "lint": "eslint ./src --quiet",
     "pre-push-check": "npm run lint && npm run test"
   },
-  "version": "1.11.4",
+  "version": "1.11.5",
   "name": "survey-analytics",
   "description": "SurveyJS analytics Library.",
   "main": "survey.analytics.js",
@@ -107,7 +107,7 @@
   "peerDependencies": {
     "@types/datatables.net": "^1.10.21",
     "@types/plotly.js-dist-min": "^2.3.0",
-    "survey-core": "1.11.4"
+    "survey-core": "1.11.5"
   },
   "husky": {
     "hooks": {

package/survey-analytics-datatables.types/utils/index.d.ts

@@ -18,6 +18,7 @@ export declare var options: {
 };
 export declare function allowDomRendering(): boolean;
 export declare function createCommercialLicenseLink(): HTMLElement;
+export declare function createLoadingIndicator(): HTMLElement;
 export declare class DataHelper {
     static zipArrays(...arrays: any[]): any[][];
     static unzipArrays(zipArray: any[][]): any[][];
@@ -35,3 +36,4 @@ export declare function createImagesContainer(links: Array<{
     name: string;
     content: any;
 }>): HTMLElement;
+export declare function toPrecision(value: number, precision?: number): number;

package/survey-analytics-tabulator.types/utils/index.d.ts

@@ -18,6 +18,7 @@ export declare var options: {
 };
 export declare function allowDomRendering(): boolean;
 export declare function createCommercialLicenseLink(): HTMLElement;
+export declare function createLoadingIndicator(): HTMLElement;
 export declare class DataHelper {
     static zipArrays(...arrays: any[]): any[][];
     static unzipArrays(zipArray: any[][]): any[][];
@@ -35,3 +36,4 @@ export declare function createImagesContainer(links: Array<{
     name: string;
     content: any;
 }>): HTMLElement;
+export declare function toPrecision(value: number, precision?: number): number;

package/survey-analytics.types/choices-table.d.ts

@@ -3,7 +3,7 @@ import { SelectBase } from "./selectBase";
 export declare class ChoicesTableAdapter {
     private model;
     constructor(model: ChoicesTable);
-    create(container: HTMLElement): void;
+    create(container: HTMLElement): Promise<void>;
     destroy(node: HTMLElement): void;
 }
 export declare class ChoicesTable extends SelectBase {
@@ -12,6 +12,6 @@ export declare class ChoicesTable extends SelectBase {
         [index: string]: any;
     }>, options?: Object, name?: string);
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
     destroy(): void;
 }

package/survey-analytics.types/dataProvider.d.ts

@@ -1,40 +1,42 @@
 import { Event } from "survey-core";
-export interface IDataInfo {
-    name: string | Array<string>;
-    getValues(): Array<any>;
-    getLabels(): Array<string>;
-    getSeriesValues(): Array<string>;
-    getSeriesLabels(): Array<string>;
-}
+export type SummaryFilter = {
+    field: string;
+    type: string;
+    value: any;
+};
+export type GetDataUsingCallbackFn = (params: {
+    visualizer: any;
+    filter?: Array<SummaryFilter>;
+    callback?: (response: {
+        data: Array<Object>;
+        error?: any;
+    }) => void;
+}) => void;
+export type GetDataUsingPromiseFn = (params: {
+    visualizer: any;
+    filter?: Array<SummaryFilter>;
+}) => Promise<Array<Object>>;
+export type GetDataFn = GetDataUsingCallbackFn | GetDataUsingPromiseFn;
 export declare class DataProvider {
     private _data;
-    private _getDataCore;
     static seriesMarkerKey: string;
     private _filteredData;
-    private _statisticsCache;
     protected filterValues: {
         [index: string]: any;
     };
-    private getStatisticsCacheKey;
-    constructor(_data?: Array<any>, _getDataCore?: (dataInfo: IDataInfo) => number[][]);
-    reset(dataInfo?: IDataInfo): void;
+    constructor(_data?: Array<any> | GetDataFn);
     get data(): Array<any>;
-    set data(data: Array<any>);
-    get filteredData(): {
-        [index: string]: any;
-    }[];
+    set data(data: Array<any> | GetDataFn);
+    get dataFn(): GetDataFn;
+    get filteredData(): Array<any>;
     /**
      * Sets filter by question name and value.
      */
     setFilter(questionName: string, selectedValue: any): void;
-    protected getDataCore(dataInfo: IDataInfo): number[][] | number[][][];
-    /**
-     * Returns calculated statisctics for the IDataInfo object.
-     */
-    getData(dataInfo: IDataInfo): any[];
     /**
      * Fires when data has been changed.
      */
     onDataChanged: Event<(sender: DataProvider, options: any) => any, DataProvider, any>;
-    protected raiseDataChanged(): void;
+    raiseDataChanged(questionName?: string): void;
+    getFilters(): SummaryFilter[];
 }

package/survey-analytics.types/histogram.d.ts

@@ -34,5 +34,6 @@ export declare class HistogramModel extends SelectBase {
     getLabels(): Array<string>;
     get hasCustomIntervals(): boolean;
     get intervals(): any;
-    getCalculatedValues(): any;
+    convertFromExternalData(externalCalculatedData: any): any[];
+    protected getCalculatedValuesCore(): Array<any>;
 }

package/survey-analytics.types/matrix.d.ts

@@ -13,5 +13,5 @@ export declare class Matrix extends SelectBase {
     private getHasAnswersInAllSeriesArray;
     private getHasAnswersInSeries;
     protected hideEmptyAnswersInData(answersData: IAnswersData): IAnswersData;
-    getCalculatedValues(): any[];
+    protected getCalculatedValuesCore(): Array<any>;
 }

package/survey-analytics.types/matrixDropdownGrouped.d.ts

@@ -5,10 +5,10 @@ export declare class MatrixDropdownGrouped extends SelectBase {
         [index: string]: any;
     }>, options?: Object, name?: string);
     protected get matrixQuestion(): QuestionMatrixDropdownModel;
-    get name(): string | Array<string>;
+    get dataNames(): Array<string>;
     getSeriesValues(): Array<string>;
     getSeriesLabels(): Array<string>;
     valuesSource(): Array<ItemValue>;
     protected isSupportMissingAnswers(): boolean;
-    getCalculatedValues(): any[];
+    protected getCalculatedValuesCore(): Array<any>;
 }

package/survey-analytics.types/nps.d.ts

@@ -1,11 +1,11 @@
 import { Question } from "survey-core";
 import { VisualizerBase } from "./visualizerBase";
 import "./nps.scss";
-export declare class NpsVizualizerWidget {
+export declare class NpsVisualizerWidget {
     private _model;
     private _data;
     private _renderedTarget;
-    constructor(_model: NpsVizualizer, _data: {
+    constructor(_model: NpsVisualizer, _data: {
         detractors: number;
         passive: number;
         promoters: number;
@@ -13,23 +13,30 @@ export declare class NpsVizualizerWidget {
     });
     private renderScorePart;
     render(target: HTMLDivElement): void;
+    get npsScore(): number;
+    get promotersPercent(): number;
+    get passivePercent(): number;
+    get detractorsPercent(): number;
     dispose(): void;
 }
 export declare class NpsAdapter {
     private model;
-    private _npsVizualizer;
-    constructor(model: NpsVizualizer);
-    get npsVizualizer(): any;
-    create(element: HTMLElement): any;
+    private _npsVisualizer;
+    constructor(model: NpsVisualizer);
+    get npsVisualizer(): any;
+    create(element: HTMLElement): Promise<any>;
     destroy(node: HTMLElement): void;
 }
-export declare class NpsVizualizer extends VisualizerBase {
+export declare class NpsVisualizer extends VisualizerBase {
+    static DetractorScore: number;
+    static PromoterScore: number;
+    precision: number;
     private _npsAdapter;
     constructor(question: Question, data: Array<{
         [index: string]: any;
     }>, options?: Object, name?: string);
-    getCalculatedValues(): any;
+    protected getCalculatedValuesCore(): any;
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
     destroy(): void;
 }

package/survey-analytics.types/number.d.ts

@@ -21,5 +21,6 @@ export declare class NumberModel extends VisualizerBase {
     generateText(maxValue: number, minValue: number, stepsCount: number): any;
     generateValues(maxValue: number, stepsCount: number): any[];
     generateColors(maxValue: number, minValue: number, stepsCount: number): any[];
-    getCalculatedValues(): any;
+    convertFromExternalData(externalCalculatedData: any): any[];
+    protected getCalculatedValuesCore(): Array<any>;
 }

package/survey-analytics.types/plotly/boolean.d.ts

@@ -12,5 +12,5 @@ export declare class BooleanPlotly extends BooleanModel {
         [index: string]: any;
     }>, options?: Object, name?: string);
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
 }

package/survey-analytics.types/plotly/histogram.d.ts

@@ -7,7 +7,7 @@ export declare class HistogramPlotly extends HistogramModel {
         [index: string]: any;
     }>, options?: Object, name?: string);
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
-    getCalculatedValues(): any[];
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
+    protected getCalculatedValuesCore(): Array<any>;
     getValueType(): "date" | "number";
 }

package/survey-analytics.types/plotly/matrix.d.ts

@@ -7,5 +7,5 @@ export declare class MatrixPlotly extends Matrix {
         [index: string]: any;
     }>, options?: Object, name?: string);
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
 }

package/survey-analytics.types/plotly/matrixdropdown-grouped.d.ts

@@ -7,5 +7,5 @@ export declare class MatrixDropdownGroupedPlotly extends MatrixDropdownGrouped {
         [index: string]: any;
     }>, options?: Object, name?: string);
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
 }

package/survey-analytics.types/plotly/ranking.d.ts

@@ -2,6 +2,6 @@ import { SelectBasePlotly } from "./selectBase";
 export declare class RankingPlotly extends SelectBasePlotly {
     getQuestionResults(): any[];
     getEmptyData(): any;
-    getCalculatedValues(): any[];
+    protected getCalculatedValuesCore(): Array<any>;
     applyResultToPlotlyData(result: any[], plotlyData: any, choices: any): void;
 }

package/survey-analytics.types/plotly/rating.d.ts

@@ -5,7 +5,7 @@ export declare class PlotlyGaugeAdapter {
     private _chart;
     constructor(model: GaugePlotly);
     get chart(): Promise<Plotly.PlotlyHTMLElement>;
-    create(chartNode: HTMLElement): any;
+    create(chartNode: HTMLElement): Promise<any>;
     destroy(node: HTMLElement): void;
 }
 export declare class GaugePlotly extends NumberModel {
@@ -16,5 +16,5 @@ export declare class GaugePlotly extends NumberModel {
         [index: string]: any;
     }>, options?: Object, name?: string);
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
 }

package/survey-analytics.types/plotly/selectBase.d.ts

@@ -6,7 +6,7 @@ export declare class PlotlyChartAdapter {
     constructor(model: SelectBase);
     protected patchConfigParameters(chartNode: object, traces: Array<object>, layout: object, config: object): void;
     get chart(): Promise<Plotly.PlotlyHTMLElement>;
-    create(chartNode: HTMLElement): any;
+    create(chartNode: HTMLElement): Promise<any>;
     destroy(node: HTMLElement): void;
 }
 export declare class SelectBasePlotly extends SelectBase {
@@ -19,6 +19,6 @@ export declare class SelectBasePlotly extends SelectBase {
         [index: string]: any;
     }, name?: string);
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
-    getCalculatedValues(): any[];
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
+    protected getCalculatedValuesCore(): Array<any>;
 }

package/survey-analytics.types/plotly/setup.d.ts

@@ -1,5 +1,5 @@
 import { Event } from "survey-core";
-import { SelectBase } from "../selectBase";
+import { IAnswersData, SelectBase } from "../selectBase";
 import { VisualizerBase } from "../visualizerBase";
 export interface PlotlyOptions {
     traces: Array<any>;
@@ -18,12 +18,12 @@ export declare class PlotlySetup {
      */
     static onPlotCreating: Event<(sender: VisualizerBase, options: any) => any, VisualizerBase, any>;
     static setups: {
-        [type: string]: (model: SelectBase) => PlotlyOptions;
+        [type: string]: (model: SelectBase, answersData: IAnswersData) => PlotlyOptions;
     };
-    static setup(charType: string, model: SelectBase): PlotlyOptions;
+    static setup(charType: string, model: SelectBase, answersData: IAnswersData): PlotlyOptions;
     static getTruncatedLabel: (label: string, labelTruncateLength: number) => string;
-    static setupPie(model: SelectBase): PlotlyOptions;
-    static setupBar(model: SelectBase): PlotlyOptions;
-    static setupVBar(model: SelectBase): PlotlyOptions;
-    static setupScatter(model: SelectBase): PlotlyOptions;
+    static setupPie(model: SelectBase, answersData: IAnswersData): PlotlyOptions;
+    static setupBar(model: SelectBase, answersData: IAnswersData): PlotlyOptions;
+    static setupVBar(model: SelectBase, answersData: IAnswersData): PlotlyOptions;
+    static setupScatter(model: SelectBase, answersData: IAnswersData): PlotlyOptions;
 }

package/survey-analytics.types/selectBase.d.ts

@@ -94,7 +94,7 @@ export declare class SelectBase extends VisualizerBase implements IVisualizerWit
     valuesSource(): Array<ItemValue>;
     getValues(): Array<any>;
     getLabels(): Array<string>;
-    getPercentages(): Array<Array<number>>;
+    getPercentages(data: Array<Array<number>>): Array<Array<number>>;
     protected answersDataReady(answersData: IAnswersData): any;
     /**
      * Fires when answer data has been combined before they passed to draw graph.
@@ -105,7 +105,8 @@ export declare class SelectBase extends VisualizerBase implements IVisualizerWit
     /**
      * Returns object with all infotmation for data visualization: datasets, labels, colors, additional texts (percentage).
      */
-    getAnswersData(): IAnswersData;
+    getAnswersData(): Promise<IAnswersData>;
+    convertFromExternalData(externalCalculatedData: any): any[];
     protected transpose(data: Array<Array<number>>): Array<Array<number>>;
     private static _stateProperties;
     getState(): any;

package/survey-analytics.types/text.d.ts

@@ -3,7 +3,7 @@ import { VisualizerBase } from "./visualizerBase";
 export declare class TextTableAdapter {
     private model;
     constructor(model: Text);
-    create(container: HTMLElement): void;
+    create(container: HTMLElement): Promise<void>;
     destroy(node: HTMLElement): void;
 }
 export declare class Text extends VisualizerBase {
@@ -11,8 +11,8 @@ export declare class Text extends VisualizerBase {
     constructor(question: Question, data: Array<{
         [index: string]: any;
     }>, options?: Object, name?: string);
-    getCalculatedValues(): any;
+    protected getCalculatedValuesCore(): any;
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
     destroy(): void;
 }

package/survey-analytics.types/utils/index.d.ts

@@ -18,6 +18,7 @@ export declare var options: {
 };
 export declare function allowDomRendering(): boolean;
 export declare function createCommercialLicenseLink(): HTMLElement;
+export declare function createLoadingIndicator(): HTMLElement;
 export declare class DataHelper {
     static zipArrays(...arrays: any[]): any[][];
     static unzipArrays(zipArray: any[][]): any[][];
@@ -35,3 +36,4 @@ export declare function createImagesContainer(links: Array<{
     name: string;
     content: any;
 }>): HTMLElement;
+export declare function toPrecision(value: number, precision?: number): number;

package/survey-analytics.types/visualizerBase.d.ts

@@ -1,6 +1,14 @@
 import { Question } from "survey-core";
-import { IDataInfo, DataProvider } from "./dataProvider";
+import { DataProvider, GetDataFn } from "./dataProvider";
 import { Event } from "survey-core";
+export interface IDataInfo {
+    name: string;
+    dataNames: Array<string>;
+    getValues(): Array<any>;
+    getLabels(): Array<string>;
+    getSeriesValues(): Array<string>;
+    getSeriesLabels(): Array<string>;
+}
 /**
  * A base object for all visualizers. Use it to implement a custom visualizer.
  *
@@ -37,6 +45,7 @@ export declare class VisualizerBase implements IDataInfo {
     private _showToolbar;
     private _footerVisualizer;
     private _dataProvider;
+    private _getDataCore;
     labelTruncateLength: number;
     protected renderResult: HTMLElement;
     protected toolbarContainer: HTMLElement;
@@ -99,7 +108,7 @@ export declare class VisualizerBase implements IDataInfo {
     };
     constructor(question: Question, data: Array<{
         [index: string]: any;
-    }>, options?: {
+    }> | GetDataFn, options?: {
         [index: string]: any;
     }, _type?: string);
     protected get questionOptions(): any;
@@ -107,7 +116,8 @@ export declare class VisualizerBase implements IDataInfo {
     /**
      * Returns the identifier of a visualized question.
      */
-    get name(): string | Array<string>;
+    get name(): string;
+    get dataNames(): Array<string>;
     /**
      * Indicates whether the visualizer displays a header. This property is `true` when a visualized question has a correct answer.
      * @see hasFooter
@@ -192,17 +202,13 @@ export declare class VisualizerBase implements IDataInfo {
     /**
      * Obsolete. Use [`surveyData`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#surveyData) instead.
      */
-    protected get data(): {
-        [index: string]: any;
-    }[];
+    protected get data(): any[];
     /**
      * 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 [`getCalculatedValues()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#getCalculatedValues) method.
      */
-    protected get surveyData(): {
-        [index: string]: any;
-    }[];
+    protected get surveyData(): any[];
     protected get dataProvider(): DataProvider;
     /**
      * Updates visualized data.
@@ -231,6 +237,7 @@ export declare class VisualizerBase implements IDataInfo {
     protected destroyHeader(container: HTMLElement): void;
     protected destroyContent(container: HTMLElement): void;
     protected renderHeader(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
     protected renderContent(container: HTMLElement): void;
     protected destroyFooter(container: HTMLElement): void;
     protected renderFooter(container: HTMLElement): void;
@@ -264,12 +271,17 @@ export declare class VisualizerBase implements IDataInfo {
      * Obsolete. Use [`getCalculatedValues()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#getCalculatedValues) instead.
      */
     getData(): any;
+    private _calculationsCache;
+    protected getCalculatedValuesCore(): Array<any>;
+    protected loadingData: boolean;
+    renderLoadingIndicator(contentContainer: HTMLElement): void;
+    convertFromExternalData(externalCalculatedData: any): any[];
     /**
      * 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 [`surveyData`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#surveyData) property.
      */
-    getCalculatedValues(): any;
+    getCalculatedValues(): Promise<Array<Object>>;
     protected _settingState: boolean;
     /**
      * Returns an object with properties that describe a current visualizer state. The properties are different for each individual visualizer.
@@ -299,3 +311,4 @@ export declare class VisualizerBase implements IDataInfo {
     set locale(newLocale: string);
     protected setLocale(newLocale: string): void;
 }
+export declare function defaultStatisticsCalculator(data: Array<any>, dataInfo: IDataInfo): Array<any>;

package/survey-analytics.types/wordcloud/wordcloud.d.ts

@@ -11,7 +11,7 @@ export declare class WordCloudAdapter {
     constructor(model: WordCloud);
     get wordcloud(): any;
     private createWordCloud2;
-    create(element: HTMLElement): any;
+    create(element: HTMLElement): Promise<any>;
     destroy(node: HTMLElement): void;
 }
 export declare class WordCloud extends VisualizerBase {
@@ -19,8 +19,9 @@ export declare class WordCloud extends VisualizerBase {
     constructor(question: Question, data: Array<{
         [index: string]: any;
     }>, options?: Object, name?: string);
-    getCalculatedValues(): any;
+    convertFromExternalData(externalCalculatedData: any): any[];
+    protected getCalculatedValuesCore(): Array<any>;
     protected destroyContent(container: HTMLElement): void;
-    protected renderContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
     destroy(): void;
 }