survey-analytics 1.9.89 → 1.9.90

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

@@ -0,0 +1,8 @@
+export * from "./setup";
+export * from "./selectBase";
+export * from "./matrix";
+export * from "./boolean";
+export * from "./ranking";
+export * from "./matrixdropdown-grouped";
+export * from "./histogram";
+export * from "./rating";

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

@@ -0,0 +1,11 @@
+import { Question } from "survey-core";
+import { Matrix } from "../matrix";
+export declare class MatrixPlotly extends Matrix {
+    private _chartAdapter;
+    static types: string[];
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: Object, name?: string);
+    protected destroyContent(container: HTMLElement): void;
+    protected renderContent(container: HTMLElement): void;
+}

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

@@ -0,0 +1,11 @@
+import { QuestionMatrixDropdownModel } from "survey-core";
+import { MatrixDropdownGrouped } from "../matrixDropdownGrouped";
+export declare class MatrixDropdownGroupedPlotly extends MatrixDropdownGrouped {
+    private _chartAdapter;
+    static types: string[];
+    constructor(question: QuestionMatrixDropdownModel, data: Array<{
+        [index: string]: any;
+    }>, options?: Object, name?: string);
+    protected destroyContent(container: HTMLElement): void;
+    protected renderContent(container: HTMLElement): void;
+}

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

@@ -0,0 +1,7 @@
+import { SelectBasePlotly } from "./selectBase";
+export declare class RankingPlotly extends SelectBasePlotly {
+    getQuestionResults(): any[];
+    getEmptyData(): any;
+    getData(): any[];
+    applyResultToPlotlyData(result: any[], plotlyData: any, choices: any): void;
+}

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

@@ -0,0 +1,20 @@
+import { Question } from "survey-core";
+import { NumberModel } from "../number";
+export declare class PlotlyGaugeAdapter {
+    private model;
+    private _chart;
+    constructor(model: GaugePlotly);
+    get chart(): Promise<Plotly.PlotlyHTMLElement>;
+    create(chartNode: HTMLElement): any;
+    destroy(node: HTMLElement): void;
+}
+export declare class GaugePlotly extends NumberModel {
+    private _chartAdapter;
+    static displayModeBar: any;
+    static types: string[];
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: Object, name?: string);
+    protected destroyContent(container: HTMLElement): void;
+    protected renderContent(container: HTMLElement): void;
+}

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

@@ -0,0 +1,24 @@
+import { Question } from "survey-core";
+import { SelectBase } from "../selectBase";
+export declare class PlotlyChartAdapter {
+    protected model: SelectBase;
+    private _chart;
+    constructor(model: SelectBase);
+    protected patchConfigParameters(chartNode: object, traces: Array<object>, layout: object, config: object): void;
+    get chart(): Promise<Plotly.PlotlyHTMLElement>;
+    create(chartNode: HTMLElement): any;
+    destroy(node: HTMLElement): void;
+}
+export declare class SelectBasePlotly extends SelectBase {
+    private _chartAdapter;
+    static types: string[];
+    static displayModeBar: any;
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: {
+        [index: string]: any;
+    }, name?: string);
+    protected destroyContent(container: HTMLElement): void;
+    protected renderContent(container: HTMLElement): void;
+    getData(): any[];
+}

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

@@ -0,0 +1,29 @@
+import { Event } from "survey-core";
+import { SelectBase } from "../selectBase";
+import { VisualizerBase } from "../visualizerBase";
+export interface PlotlyOptions {
+    traces: Array<any>;
+    layout: any;
+    hasSeries: boolean;
+}
+export declare class PlotlySetup {
+    static imageExportFormat: string;
+    /**
+     * Fires when end user clicks on the 'save as image' button.
+     */
+    static onImageSaving: Event<(sender: SelectBase, options: any) => any, SelectBase, any>;
+    /**
+     * Fires before plot will be created. User can change traces, layout and config of the plot.
+     * Options is an object with the following fields: traces, layout and config of the plot.
+     */
+    static onPlotCreating: Event<(sender: VisualizerBase, options: any) => any, VisualizerBase, any>;
+    static setups: {
+        [type: string]: (model: SelectBase) => PlotlyOptions;
+    };
+    static setup(charType: string, model: SelectBase): 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;
+}

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

@@ -0,0 +1,112 @@
+import { Question, ItemValue, Event } from "survey-core";
+import { VisualizerBase } from "./visualizerBase";
+export interface IVisualizerWithSelection {
+    selection: ItemValue;
+    onDataItemSelected: (selectedValue: any, selectedText: string) => void;
+    setSelection(item: ItemValue): void;
+}
+export interface IAnswersData {
+    datasets: Array<Array<any>>;
+    labels: Array<string>;
+    colors: Array<string>;
+    texts: Array<Array<any>>;
+    seriesLabels: Array<string>;
+}
+export declare class SelectBase extends VisualizerBase implements IVisualizerWithSelection {
+    protected selectedItem: ItemValue;
+    private choicesOrderSelector;
+    private showPercentageBtn;
+    private emptyAnswersBtn;
+    private transposeDataBtn;
+    private topNSelector;
+    private _showPercentages;
+    private _showOnlyPercentages;
+    private _percentagePrecision;
+    protected _answersOrder: string;
+    protected _supportSelection: boolean;
+    private _hideEmptyAnswers;
+    private _topN;
+    static topNValuesDefaults: number[];
+    topNValues: any[];
+    private _transposeData;
+    private _showMissingAnswers;
+    private missingAnswersBtn;
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: any, name?: string);
+    protected chartTypes: string[];
+    protected _chartType: string;
+    /**
+     * Chart type - current chart type.
+     */
+    get chartType(): string;
+    set chartType(newChartType: string);
+    private updateEmptyAnswersBtn;
+    private updateTransposeDataBtn;
+    private updateOrderSelector;
+    private updateShowPercentageBtn;
+    private updateTopNSelector;
+    private updateMissingAnswersBtn;
+    protected onChartTypeChanged(): void;
+    protected setChartType(chartType: string): void;
+    protected getCorrectAnswerText(): string;
+    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;
+    onDataItemSelected: (selectedValue: any, selectedText: string) => void;
+    get showValuesInOriginalOrder(): boolean;
+    valuesSource(): Array<ItemValue>;
+    getValues(): Array<any>;
+    getLabels(): Array<string>;
+    getPercentages(): Array<Array<number>>;
+    protected hideEmptyAnswersInData(answersData: IAnswersData): IAnswersData;
+    protected answersDataReady(answersData: IAnswersData): any;
+    /**
+     * Fires when answer data has been combined before they passed to draw graph.
+     * options - the answers data object containing: datasets, labels, colors, additional texts (percentage).
+     * options fields can be modified
+     */
+    onAnswersDataReady: Event<(sender: SelectBase, options: any) => any, SelectBase, any>;
+    /**
+     * Returns object with all infotmation for data visualization: datasets, labels, colors, additional texts (percentage).
+     */
+    getAnswersData(): IAnswersData;
+    protected transpose(data: Array<Array<number>>): Array<Array<number>>;
+    private static _stateProperties;
+    getState(): any;
+    setState(state: any): void;
+}

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

@@ -0,0 +1,21 @@
+import { Question } from "survey-core";
+import { VisualizerBase } from "./visualizerBase";
+export declare class TextTableAdapter {
+    private model;
+    constructor(model: Text);
+    create(container: HTMLElement): void;
+    destroy(node: HTMLElement): void;
+}
+export declare class Text extends VisualizerBase {
+    private _textTableAdapter;
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: Object, name?: string);
+    getData(): {
+        columnsCount: number;
+        data: string[][];
+    };
+    protected destroyContent(container: HTMLElement): void;
+    protected renderContent(container: HTMLElement): void;
+    destroy(): void;
+}

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

@@ -0,0 +1,37 @@
+export declare class DocumentHelper {
+    static createSelector(options: Array<{
+        value: string;
+        text: string;
+    }>, isSelected: (option: {
+        value: string;
+        text: string;
+    }) => boolean, handler: (e: any) => void): HTMLDivElement;
+    static createButton(handler: (e: any) => void, text?: string, className?: string): HTMLElement;
+    static createElement(tagName: string, className?: string, attrs?: any): HTMLElement;
+    static createSvgElement(path: string): SVGSVGElement;
+    static createSvgButton(path: string): HTMLButtonElement;
+    static createSvgToggleButton(svgPath1: string, svPpath2: string, text1: string, text2: string, handler1: (e: any) => any, handler2: (e: any) => any, state?: string, className?: string): HTMLElement;
+    static createInput(className: string, placeholder?: string, defaultValue?: string): HTMLInputElement;
+}
+export declare var options: {
+    runningInBrowser: boolean;
+};
+export declare function allowDomRendering(): boolean;
+export declare function createCommercialLicenseLink(): HTMLElement;
+export declare class DataHelper {
+    static zipArrays(...arrays: any[]): any[][];
+    static unzipArrays(zipArray: any[][]): any[][];
+    static sortDictionary(keys: any[], values: any[], desc: boolean): {
+        keys: any[];
+        values: any[];
+    };
+    static toPercentage(value: number, maxValue: number): number;
+}
+export declare function createLinksContainer(links: Array<{
+    name: string;
+    content: any;
+}>): HTMLElement;
+export declare function createImagesContainer(links: Array<{
+    name: string;
+    content: any;
+}>): HTMLElement;

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

@@ -0,0 +1,52 @@
+import { Question } from "survey-core";
+declare type VisualizerConstructor = new (question: Question, data: Array<{
+    [index: string]: any;
+}>, options?: Object) => any;
+/**
+ * An object with methods used to register and unregister visualizers for individual question types.
+ *
+ * [View Demo](https://surveyjs.io/dashboard/examples/visualize-answers-from-text-entry-fields-with-charts/ (linkStyle))
+ */
+export declare class VisualizationManager {
+    static alternativesVisualizer: any;
+    static vizualizers: {
+        [index: string]: Array<VisualizerConstructor>;
+    };
+    /**
+     * Registers a visualizer for a specified question type.
+     *
+     * [View Demo](https://surveyjs.io/dashboard/examples/visualize-answers-from-text-entry-fields-with-charts/ (linkStyle))
+     * @param questionType A question [type](https://surveyjs.io/form-library/documentation/api-reference/question#getType).
+     * @param constructor A function that returns a visualizer constructor to register.
+     */
+    static registerVisualizer(questionType: string, constructor: VisualizerConstructor): void;
+    /**
+     * Unregisters a visualizer for a specified question type.
+     *
+     * [View Demo](https://surveyjs.io/dashboard/examples/visualize-answers-from-text-entry-fields-with-charts/ (linkStyle))
+     * @param questionType A question [type](https://surveyjs.io/form-library/documentation/api-reference/question#getType).
+     * @param constructor A function that returns a visualizer constructor to unregister.
+     */
+    static unregisterVisualizer(questionType: string, constructor: VisualizerConstructor): void;
+    /**
+     * Unregisters a visualizer for all question types.
+     * @param constructor A function that returns a visualizer constructor to unregister.
+     */
+    static unregisterVisualizerForAll(constructor: VisualizerConstructor): void;
+    /**
+     * Returns all visualizer constructors for a specified question type.
+     * @param questionType A question [type](https://surveyjs.io/form-library/documentation/api-reference/question#getType).
+     */
+    static getVisualizersByType(questionType: string): VisualizerConstructor[];
+    /**
+     * Returns a constructor for an alternative visualizer selector.
+     * @see registerAlternativesVisualizer
+     */
+    static getAlternativesVisualizer(): any;
+    /**
+     * Registers an alternative visualizer selector.
+     * @param constructor A function that returns a constructor for an alternative visualizer selector.
+     */
+    static registerAlternativesVisualizer(constructor: any): void;
+}
+export {};

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

@@ -0,0 +1,23 @@
+import { QuestionMatrixDropdownModel } from "survey-core";
+import { VisualizerBase } from "./visualizerBase";
+export declare class VisualizationMatrixDropdown extends VisualizerBase {
+    protected _matrixDropdownVisualizer: VisualizerBase;
+    private readonly _childOptions;
+    constructor(question: QuestionMatrixDropdownModel, data: Array<{
+        [index: string]: any;
+    }>, options?: {
+        [index: string]: any;
+    }, name?: string);
+    protected setLocale(newLocale: string): void;
+    get matrixDropdownVisualizer(): VisualizerBase;
+    private onPanelAfterRenderCallback;
+    private updateDropdownVisualizerData;
+    updateData(data: Array<{
+        [index: string]: any;
+    }>): void;
+    protected onDataChanged(): void;
+    getQuestions(): any[];
+    destroyContent(container: HTMLElement): void;
+    renderContent(container: HTMLElement): void;
+    destroy(): void;
+}

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

@@ -0,0 +1,9 @@
+import { Question } from "survey-core";
+import { VisualizationPanelDynamic } from "./visualizationPanelDynamic";
+export declare class VisualizationMatrixDynamic extends VisualizationPanelDynamic {
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: Object);
+    get type(): string;
+    getQuestions(): Question[];
+}