survey-analytics 1.9.94 → 1.9.96

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -20,7 +20,7 @@
20
20
  "lint": "eslint ./src --quiet",
21
21
  "pre-push-check": "npm run lint && npm run test"
22
22
  },
23
- "version": "1.9.94",
23
+ "version": "1.9.96",
24
24
  "name": "survey-analytics",
25
25
  "description": "SurveyJS analytics Library.",
26
26
  "main": "survey.analytics.js",
@@ -58,7 +58,7 @@
58
58
  "jquery": "3.5.0",
59
59
  "muuri": "^0.8.0",
60
60
  "plotly.js-dist-min": "^2.11.1",
61
- "survey-core": "1.9.94",
61
+ "survey-core": "1.9.96",
62
62
  "tabulator-tables": "4.8.4",
63
63
  "wordcloud": "^1.2.2"
64
64
  },
@@ -27,9 +27,9 @@ export declare class VisualizationManager {
27
27
  * @param questionType A question [type](https://surveyjs.io/form-library/documentation/api-reference/question#getType).
28
28
  * @param constructor A function that returns a visualizer constructor to unregister.
29
29
  */
30
- static unregisterVisualizer(questionType: string, constructor: VisualizerConstructor): void;
30
+ static unregisterVisualizer(questionType: string | undefined, constructor: VisualizerConstructor): void;
31
31
  /**
32
- * Unregisters a visualizer for all question types.
32
+ * Obsolete. Pass `undefined` to the [`unregisterVisualizer`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationmanager#unregisterVisualizer) method instead.
33
33
  * @param constructor A function that returns a visualizer constructor to unregister.
34
34
  */
35
35
  static unregisterVisualizerForAll(constructor: VisualizerConstructor): void;
@@ -40,13 +40,13 @@ export declare class VisualizationManager {
40
40
  static getVisualizersByType(questionType: string): VisualizerConstructor[];
41
41
  /**
42
42
  * Returns a constructor for an alternative visualizer selector.
43
- * @see registerAlternativesVisualizer
43
+ * @see registerAltVisualizerSelector
44
44
  */
45
- static getAlternativesVisualizer(): any;
45
+ static getAltVisualizerSelector(): any;
46
46
  /**
47
47
  * Registers an alternative visualizer selector.
48
48
  * @param constructor A function that returns a constructor for an alternative visualizer selector.
49
49
  */
50
- static registerAlternativesVisualizer(constructor: any): void;
50
+ static registerAltVisualizerSelector(constructor: any): void;
51
51
  }
52
52
  export {};
@@ -306,10 +306,11 @@ export declare class VisualizationPanel extends VisualizerBase {
306
306
  protected buildElements(questions: any[]): IVisualizerPanelElement[];
307
307
  /**
308
308
  * Returns an array of [`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement) objects with information about visualization items.
309
+ * @param questionNames Question [names](https://surveyjs.io/form-library/documentation/api-reference/question#name). Do not specify this parameter to get an array of all visualization items.
309
310
  * @see visibleElements
310
311
  * @see hiddenElements
311
312
  */
312
- getElements(): IVisualizerPanelElement[];
313
+ getElements(questionNames?: Array<string>): IVisualizerPanelElement[];
313
314
  /**
314
315
  * Returns an array of [`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement) objects with information about currently visible visualization items.
315
316
  *
@@ -330,16 +331,21 @@ export declare class VisualizationPanel extends VisualizerBase {
330
331
  get privateElements(): IVisualizerPanelRenderedElement[];
331
332
  protected get locales(): any;
332
333
  /**
333
- * Returns panel element description by the question name.
334
+ * Returns a visualization item with a specified question name.
335
+ * @param name A question [name](https://surveyjs.io/form-library/documentation/api-reference/question#name).
334
336
  */
335
- getElement(name: string): IVisualizerPanelRenderedElement;
337
+ getElement(questionName: string): IVisualizerPanelRenderedElement;
336
338
  /**
337
339
  * Returns a [visualizer](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase) that visualizes a specified survey question.
338
340
  * @param questionName A question [name](https://surveyjs.io/form-library/documentation/api-reference/question#name).
339
341
  */
340
342
  getVisualizer(questionName: string): VisualizerBase;
341
343
  /**
342
- * An event that is raised when users [move a visualization item](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizationpaneloptions#allowDynamicLayout) or [toggle its visibility](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizationpaneloptions#allowHideQuestions).
344
+ * Obsolete. Use [`onElementShown`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#onElementShown), [`onElementHidden`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#onElementHidden), or [`onElementMoved`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#onElementMoved) instead.
345
+ */
346
+ onVisibleElementsChanged: Event<(sender: VisualizationPanel, options: any) => any, VisualizationPanel, any>;
347
+ /**
348
+ * An event that is raised when users [show a visualization item](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizationpaneloptions#allowHideQuestions).
343
349
  *
344
350
  * Parameters:
345
351
  *
@@ -347,15 +353,42 @@ export declare class VisualizationPanel extends VisualizerBase {
347
353
  * A `VisualizationPanel` that raised the event.
348
354
  *
349
355
  * - `options.elements`: Array\<[`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement)\>\
350
- * Information about visualization items rendered by this `VisualizationPanel`.
356
+ * Information about all visualization items rendered by this `VisualizationPanel`.
357
+ *
358
+ * - `options.element`: [`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement)\
359
+ * A visualization item that has been shown.
360
+ */
361
+ onElementShown: Event<(sender: VisualizationPanel, options: any) => any, VisualizationPanel, any>;
362
+ /**
363
+ * An event that is raised when users [hide a visualization item](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizationpaneloptions#allowHideQuestions).
351
364
  *
352
- * - `options.changed`: [`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement)\
353
- * A visualization item that has been changed.
365
+ * Parameters:
366
+ *
367
+ * - `sender`: [`VisualizationPanel`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel)\
368
+ * A `VisualizationPanel` that raised the event.
369
+ *
370
+ * - `options.elements`: Array\<[`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement)\>\
371
+ * Information about all visualization items rendered by this `VisualizationPanel`.
354
372
  *
355
- * - `options.reason`: `"ADDED"` | `"REMOVED"` | `"MOVED"`\
356
- * Indicates the reason why the event has been raised.
373
+ * - `options.element`: [`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement)\
374
+ * A visualization item that has been hidden.
357
375
  */
358
- onVisibleElementsChanged: Event<(sender: VisualizationPanel, options: any) => any, VisualizationPanel, any>;
376
+ onElementHidden: Event<(sender: VisualizationPanel, options: any) => any, VisualizationPanel, any>;
377
+ /**
378
+ * An event that is raised when users [move a visualization item](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizationpaneloptions#allowDynamicLayout).
379
+ *
380
+ * Parameters:
381
+ *
382
+ * - `sender`: [`VisualizationPanel`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel)\
383
+ * A `VisualizationPanel` that raised the event.
384
+ *
385
+ * - `options.elements`: Array\<[`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement)\>\
386
+ * Information about all visualization items rendered by this `VisualizationPanel`.
387
+ *
388
+ * - `options.element`: [`IVisualizerPanelElement`](https://surveyjs.io/dashboard/documentation/api-reference/ivisualizerpanelelement)\
389
+ * A visualization item that has been moved.
390
+ */
391
+ onElementMoved: Event<(sender: VisualizationPanel, options: any) => any, VisualizationPanel, any>;
359
392
  protected visibleElementsChanged(element: IVisualizerPanelElement, reason: string): void;
360
393
  onStateChanged: Event<(sender: VisualizationPanel, state: IState) => any, VisualizationPanel, any>;
361
394
  onPermissionsChangedCallback: any;
@@ -158,12 +158,18 @@ export declare class VisualizerBase implements IDataInfo {
158
158
  * Returns the visualizer's type.
159
159
  */
160
160
  get type(): string;
161
+ /**
162
+ * Obsolete. Use [`surveyData`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#surveyData) instead.
163
+ */
164
+ protected get data(): {
165
+ [index: string]: any;
166
+ }[];
161
167
  /**
162
168
  * Returns an array of survey results used to calculate values for visualization. If a user applies a filter, the array is also filtered.
163
169
  *
164
- * To get an array of calculated and visualized values, call the [`getData()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#getData) method.
170
+ * To get an array of calculated and visualized values, call the [`getCalculatedValues()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#getCalculatedValues) method.
165
171
  */
166
- protected get data(): {
172
+ protected get surveyData(): {
167
173
  [index: string]: any;
168
174
  }[];
169
175
  protected get dataProvider(): DataProvider;
@@ -223,12 +229,16 @@ export declare class VisualizerBase implements IDataInfo {
223
229
  */
224
230
  get showToolbar(): boolean;
225
231
  set showToolbar(newValue: boolean);
232
+ /**
233
+ * Obsolete. Use [`getCalculatedValues()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#getCalculatedValues) instead.
234
+ */
235
+ getData(): any;
226
236
  /**
227
237
  * Returns an array of calculated and visualized values. If a user applies a filter, the array is also filtered.
228
238
  *
229
- * To get an array of source survey results, use the [`data`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#data) property.
239
+ * To get an array of source survey results, use the [`surveyData`](https://surveyjs.io/dashboard/documentation/api-reference/visualizerbase#surveyData) property.
230
240
  */
231
- getData(): any;
241
+ getCalculatedValues(): any;
232
242
  /**
233
243
  * Returns an object with properties that describe a current visualizer state. The properties are different for each individual visualizer.
234
244
  *
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * surveyjs - SurveyJS Dashboard library v1.9.94
2
+ * surveyjs - SurveyJS Dashboard library v1.9.96
3
3
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ - http://surveyjs.io/
4
4
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
5
5
  */
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * surveyjs - SurveyJS Dashboard library v1.9.94
2
+ * surveyjs - SurveyJS Dashboard library v1.9.96
3
3
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ - http://surveyjs.io/
4
4
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
5
5
  */
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * surveyjs - SurveyJS Dashboard library v1.9.94
2
+ * surveyjs - SurveyJS Dashboard library v1.9.96
3
3
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ - http://surveyjs.io/
4
4
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
5
5
  */
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * surveyjs - SurveyJS Dashboard library v1.9.94
2
+ * surveyjs - SurveyJS Dashboard library v1.9.96
3
3
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ - http://surveyjs.io/
4
4
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
5
5
  */
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * surveyjs - SurveyJS Dashboard library v1.9.94
2
+ * surveyjs - SurveyJS Dashboard library v1.9.96
3
3
  * Copyright (c) 2015-2023 Devsoft Baltic OÜ - http://surveyjs.io/
4
4
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
5
5
  */