survey-analytics 2.5.16 → 3.0.0-beta.1

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

@@ -1,5 +1,8 @@
 import { Question, Event } from "survey-core";
 import { DataProvider, GetDataFn } from "./dataProvider";
+import { DashboardTheme, IDashboardTheme } from "./theme";
+import { SidebarWidget } from "./utils/sidebarWidget";
+import { SideBarItemCreators } from "./sideBarItemCreators";
 import "./visualizerBase.scss";
 export interface IChartAdapter {
     getChartTypes(): string[];
@@ -7,6 +10,28 @@ export interface IChartAdapter {
     update(chartNode: HTMLElement): Promise<any>;
     destroy(node: HTMLElement): void;
 }
+export interface ICalculatedDataInfo {
+    dataPath?: string;
+    valueNames: Array<string>;
+    seriesNames?: Array<string>;
+    getLabel?(value: string): string;
+    getSeriesLabel?(series: string): string;
+}
+export declare type ICalculationResult<T = number> = {
+    data: Array<Array<T>>;
+    values: Array<string>;
+    series?: Array<string>;
+};
+export interface IAnswersData {
+    datasets: Array<Array<any>>;
+    values: Array<string>;
+    labels: Array<string>;
+    colors: Array<string>;
+    texts: Array<Array<any>>;
+    seriesLabels: Array<string>;
+    labelsTitle?: string;
+    valuesTitle?: string;
+}
 export interface IDataInfo {
     name: string;
     dataPath?: string;
@@ -16,12 +41,16 @@ export interface IDataInfo {
     getSeriesValues(): Array<string>;
     getSeriesLabels(): Array<string>;
 }
+export type ToolbarItemType = "button" | "dropdown" | "filter" | "license";
 type ToolbarItemCreators = {
     [name: string]: {
         creator: (toolbar?: HTMLDivElement) => HTMLElement;
-        order: number;
+        type: ToolbarItemType;
+        index: number;
+        groupIndex: number;
     };
 };
+export { IVisualizerOptions } from "./visualizer-interfaces";
 export declare class PostponeHelper {
     static postponeFunction: (fn: () => void, timeout?: number) => any;
     static postpone(fn: () => void, timeout?: number): any;
@@ -60,7 +89,10 @@ export declare class VisualizerBase implements IDataInfo {
     private _type?;
     static haveCommercialLicense: boolean;
     static suppressVisualizerStubRendering: boolean;
-    static chartAdapterType: any;
+    static get chartAdapterType(): any;
+    static set chartAdapterType(value: any);
+    private _appliedTheme;
+    private _theme;
     private _showToolbar;
     private _footerVisualizer;
     private _dataProvider;
@@ -127,7 +159,25 @@ export declare class VisualizerBase implements IDataInfo {
     protected stateChanged(name: string, value: any): void;
     protected toolbarItemCreators: ToolbarItemCreators;
     onGetToolbarItemCreators: () => ToolbarItemCreators;
+    protected sideBarItemCreators: SideBarItemCreators;
+    onGetSideBarItemCreators: () => SideBarItemCreators;
+    protected _sidebarWidget: SidebarWidget | undefined;
     protected getToolbarItemCreators(): ToolbarItemCreators;
+    protected createSidebarPanelButton(_toolbar?: HTMLDivElement): HTMLElement;
+    /**
+     * Registers a sidebar item creator by name. The item will be rendered in the sidebar panel when the sidebar button is used.
+     * @param name Unique name for the sidebar item.
+     * @param creator Function that receives the panel container and returns an HTMLElement to be appended.
+     * @param index Optional order index (default 100). Lower values appear first.
+     * @param groupIndex Optional group index (default 0). Items are ordered by group first, then by index within group.
+     */
+    registerSideBarItem(name: string, creator: (container: HTMLDivElement) => HTMLElement, index?: number, groupIndex?: number): void;
+    /**
+     * Unregisters a sidebar item creator.
+     * @param name Name of the sidebar item to remove.
+     * @returns The previously registered creator function, or undefined.
+     */
+    unregisterSideBarItem(name: string): ((container: HTMLDivElement) => HTMLElement) | undefined;
     constructor(question: Question, data: Array<{
         [index: string]: any;
     }> | GetDataFn, options?: {
@@ -135,6 +185,8 @@ export declare class VisualizerBase implements IDataInfo {
     }, _type?: string);
     protected get questionOptions(): any;
     protected onDataChanged(): void;
+    protected getName(): string;
+    protected get allowChangeType(): any;
     /**
      * Returns the identifier of a visualized question.
      */
@@ -167,6 +219,7 @@ export declare class VisualizerBase implements IDataInfo {
     getSeriesLabels(): Array<string>;
     getValues(): Array<any>;
     getLabels(): Array<string>;
+    getChartAdapter(): IChartAdapter;
     /**
      * Registers a function used to create a toolbar item for this visualizer.
      *
@@ -211,7 +264,7 @@ export declare class VisualizerBase implements IDataInfo {
      * @param creator A function that accepts the toolbar and should return an `HTMLElement` with the toolbar item.
      * @see unregisterToolbarItem
      */
-    registerToolbarItem(name: string, creator: (toolbar?: HTMLDivElement) => HTMLElement, order?: number): void;
+    registerToolbarItem(name: string, creator: (toolbar?: HTMLDivElement) => HTMLElement, type: ToolbarItemType, index?: number, groupIndex?: number): void;
     /**
      *
      * Unregisters a function used to create a toolbar item. Allows you to remove a toolbar item.
@@ -229,6 +282,7 @@ export declare class VisualizerBase implements IDataInfo {
      * Returns the visualizer's type.
      */
     get type(): string;
+    get dataType(): string;
     /**
      * @deprecated Use [`surveyData`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel#surveyData) instead.
      */
@@ -260,8 +314,11 @@ export declare class VisualizerBase implements IDataInfo {
      * 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;
+    getSortedToolbarItemCreators(): Array<any>;
     protected createToolbarItems(toolbar: HTMLDivElement): void;
     protected getCorrectAnswerText(): string;
+    resetContentFilter(): void;
+    protected renderBanner(container: HTMLElement): void;
     protected destroyToolbar(container: HTMLElement): void;
     protected renderToolbar(container: HTMLElement): void;
     protected destroyHeader(container: HTMLElement): void;
@@ -278,7 +335,7 @@ export declare class VisualizerBase implements IDataInfo {
      * 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;
+    render(targetElement: HTMLElement | string, isRoot?: boolean): void;
     updateToolbar(): void;
     protected isSupportSoftUpdateContent(): boolean;
     protected softUpdateContent(): void;
@@ -288,16 +345,21 @@ export declare class VisualizerBase implements IDataInfo {
      * Re-renders the visualizer and its content.
      */
     refresh(): void;
+    refreshContent(): void;
     protected processText(text: string): string;
     getRandomColor(): any;
     private _backgroundColor;
-    get backgroundColor(): string;
-    set backgroundColor(value: string);
-    protected getBackgroundColorCore(): string;
+    get backgroundColor(): any;
+    set backgroundColor(value: any);
+    protected getBackgroundColorCore(): any;
     protected setBackgroundColorCore(color: string): void;
+    protected onThemeChanged(): void;
+    get theme(): DashboardTheme;
+    set theme(theme: DashboardTheme);
+    applyTheme(theme: IDashboardTheme): void;
     static customColors: string[];
     private static colors;
-    getColors(count?: number): any;
+    static getColors(count?: number): any;
     /**
      * Gets or sets the visibility of the visualizer's toolbar.
      *
@@ -310,17 +372,23 @@ export declare class VisualizerBase implements IDataInfo {
      */
     getData(): any;
     private _calculationsCache;
-    protected getCalculatedValuesCore(): Array<any>;
+    protected getCalculatedValuesCore(): ICalculationResult;
     protected loadingData: boolean;
     renderLoadingIndicator(contentContainer: HTMLElement): void;
-    convertFromExternalData(externalCalculatedData: any): any[];
+    convertFromExternalData(externalCalculatedData: any): ICalculationResult;
+    /**
+     * Returns object with all infotmation for data visualization: datasets, labels, colors, additional texts (percentage).
+     */
+    getAnswersData(): Promise<IAnswersData>;
     /**
      * 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(): Promise<Array<Object>>;
+    getCalculatedValues(): Promise<ICalculationResult>;
     protected _settingState: boolean;
+    protected _defaultStateValue: any;
+    getDefaultState(): any;
     /**
      * Returns an object with properties that describe a current visualizer state. The properties are different for each individual visualizer.
      *
@@ -330,6 +398,7 @@ export declare class VisualizerBase implements IDataInfo {
      * @see onStateChanged
      */
     getState(): any;
+    protected setStateCore(state: any): void;
     /**
      * Sets the visualizer's state.
      *
@@ -364,4 +433,3 @@ export declare class VisualizerBase implements IDataInfo {
     set locale(newLocale: string);
     protected setLocale(newLocale: string): void;
 }
-export {};

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

@@ -0,0 +1,4 @@
+import { Question } from "survey-core";
+import { IVisualizerDescription, IVisualizerOptions } from "./visualizer-interfaces";
+export declare function getDataName(description: Question | IVisualizerDescription): any;
+export declare function createVisualizerDescription(vOptions: IVisualizerOptions, question: Question): IVisualizerDescription;

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

@@ -1,5 +1,6 @@
 import { Question } from "survey-core";
 import { VisualizerBase } from "./visualizerBase";
+import { IVisualizerDescription } from "./visualizer-interfaces";
 /**
  * An object that allows you to create individual visualizers without creating a [visualization panel](https://surveyjs.io/dashboard/documentation/api-reference/visualizationpanel).
  */
@@ -20,13 +21,21 @@ export declare class VisualizerFactory {
      * ```
      *
      * If a question has more than one [registered](https://surveyjs.io/dashboard/documentation/api-reference/visualizationmanager#registerVisualizer) visualizer, users can switch between them using a drop-down menu.
-     * @param question A question for which to create a visualizer.
+     * @param description A question for which to create a visualizer.
      * @param data A data array with survey results to be visualized.
      * @param options An object with any custom properties you need within the visualizer.
      */
-    static createVisualizer(question: Question, data: Array<{
+    static createVisualizer(description: Question | IVisualizerDescription, data: Array<{
         [index: string]: any;
     }>, options?: {
         [index: string]: any;
     }): VisualizerBase;
+    static getVisualizerCreatorsByQuestion(question: Question): Array<{
+        typeName: string;
+        creator: any;
+    }>;
+    static getVisualizerCreatorsByDescription(description: IVisualizerDescription): Array<{
+        typeName: string;
+        creator: any;
+    }>;
 }

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

@@ -1,5 +1,5 @@
 import { Question, Event } from "survey-core";
-import { VisualizerBase } from "../visualizerBase";
+import { ICalculationResult, VisualizerBase } from "../visualizerBase";
 export declare class WordCloudAdapter {
     private model;
     private _wordcloud;
@@ -15,11 +15,13 @@ export declare class WordCloudAdapter {
 }
 export declare class WordCloud extends VisualizerBase {
     private _wordcloudAdapter;
+    private _values;
     constructor(question: Question, data: Array<{
         [index: string]: any;
-    }>, options?: Object, name?: string);
-    convertFromExternalData(externalCalculatedData: any): any[];
-    protected getCalculatedValuesCore(): Array<any>;
+    }>, options?: Object, type?: string);
+    convertFromExternalData(externalCalculatedData: any): ICalculationResult;
+    getValues(): Array<any>;
+    protected getCalculatedValuesCore(): ICalculationResult;
     protected destroyContent(container: HTMLElement): void;
     protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
     destroy(): void;