survey-analytics 2.5.13 → 3.0.0-beta.0

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

@@ -0,0 +1,102 @@
+import { ItemValue, Question } from "survey-core";
+import { SelectBase } from "./selectBase";
+import { IAnswersData, ICalculationResult } from "./visualizerBase";
+export declare type HistogramIntervalMode = "auto" | "custom" | "decades" | "years" | "quarters" | "months" | "days";
+export interface IHistogramInterval {
+    start: number;
+    end: number;
+    label: string;
+}
+export declare function getBestIntervalMode(min: number, max: number): HistogramIntervalMode;
+export declare const intervalCalculators: {
+    decades: (min: number, max: number) => any[];
+    years: (min: number, max: number) => any[];
+    months: (min: number, max: number) => any[];
+    quarters: (min: number, max: number) => any[];
+    days: (min: number, max: number) => any[];
+};
+export declare class HistogramModel extends SelectBase {
+    protected valueType: "date" | "number" | "enum";
+    protected _cachedValues: Array<{
+        original: any;
+        continuous: number;
+        row: any;
+    }>;
+    private _continuousData;
+    protected _cachedIntervals: Array<{
+        start: number;
+        end: number;
+        label: string;
+    }>;
+    protected _intervalPrecision: number;
+    private showRunningTotalsBtn;
+    private showGroupedBtn;
+    private changeIntervalsModeSelector;
+    private aggregateDataNameSelector;
+    static IntervalsCount: number;
+    static UseIntervalsFrom: number;
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: Object, type?: string);
+    private updateIntervalsModeSelector;
+    private updateAggregateDataNameSelector;
+    getQuestionValueType(question: Question, defaultValue?: string): "enum" | "date" | "number";
+    protected reset(): void;
+    getContinuousValue(value: any): number;
+    getString(value: number): string;
+    protected toPrecision(value: number): number;
+    getSelectedItemByText(itemText: string): ItemValue;
+    /**
+     * Updates visualizer data.
+     */
+    updateData(data: Array<{
+        [index: string]: any;
+    }>): void;
+    protected onDataChanged(): void;
+    protected onSelectionChanged(item: ItemValue): void;
+    protected getContinuousValues(): {
+        original: any;
+        continuous: number;
+        row: any;
+    }[];
+    protected isSupportSoftUpdateContent(): boolean;
+    protected isSupportMissingAnswers(): boolean;
+    protected get needUseRateValues(): boolean;
+    getValues(): Array<any>;
+    getLabels(): Array<string>;
+    get hasCustomIntervals(): boolean;
+    get intervals(): Array<{
+        start: number;
+        end: number;
+        label: string;
+    }>;
+    intervalModes: HistogramIntervalMode[];
+    private _intervalsMode;
+    get intervalsMode(): HistogramIntervalMode;
+    set intervalsMode(val: HistogramIntervalMode);
+    get allowChangeIntervals(): boolean;
+    private _showRunningTotals;
+    get showRunningTotals(): boolean;
+    set showRunningTotals(val: boolean);
+    private updateShowRunningTotalsBtn;
+    private _showGrouped;
+    get showGrouped(): boolean;
+    set showGrouped(val: boolean);
+    private updateShowGroupedBtn;
+    get canShowGroupedDateSeries(): boolean;
+    private _aggregateDataName;
+    get aggregateDataName(): string;
+    set aggregateDataName(val: string);
+    get possibleAggregateDataNames(): Array<string>;
+    convertFromExternalData(externalCalculatedData: Array<number>): ICalculationResult;
+    protected getCalculatedValuesCore(): ICalculationResult;
+    getCalculatedValues(): Promise<ICalculationResult>;
+    private getGroupedDateAnswersData;
+    /**
+     * Returns object with all infotmation for data visualization: datasets, labels, colors, additional texts (percentage).
+     */
+    getAnswersData(): Promise<IAnswersData>;
+    private static _histogramDefaultState;
+    getDefaultState(): any;
+    getValueType(): "date" | "number" | "enum";
+}

package/{survey-analytics.types/layoutEngine.d.ts → survey-analytics-plotly.types/layout-engine.d.ts}

@@ -27,15 +27,3 @@ export declare class LayoutEngine {
     onMoveCallback: (order: Array<string>) => void;
     destroy(): void;
 }
-export declare class MuuriLayoutEngine extends LayoutEngine {
-    private _selector;
-    private dragEnabled;
-    private _muuri;
-    private _layoutingTimer;
-    constructor(allowed: boolean, _selector: string, dragEnabled?: boolean);
-    protected startCore(container: HTMLElement): void;
-    protected stopCore(): void;
-    protected updateCore(): void;
-    add(elements: Array<HTMLElement>, options?: any): void;
-    remove(elements: Array<HTMLElement>, options?: any): void;
-}

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

@@ -0,0 +1,152 @@
+export declare var localization: {
+    currentLocaleValue: string;
+    defaultLocaleValue: string;
+    locales: {
+        [index: string]: any;
+    };
+    localeNames: {
+        [index: string]: any;
+    };
+    supportedLocales: Array<any>;
+    currentLocale: string;
+    defaultLocale: string;
+    setupLocale: (loc: string, strings: any) => void;
+    getLocaleName: (loc: string, inEnglish?: boolean) => string;
+    getString: (strName: string) => any;
+    getLocales: () => Array<string>;
+};
+export declare var surveyStrings: {
+    groupButton: string;
+    ungroupButton: string;
+    selectButton: string;
+    columnReorder: string;
+    hideColumn: string;
+    showColumn: string;
+    columns: string;
+    makePrivateColumn: string;
+    makePublicColumn: string;
+    moveToDetail: string;
+    showAsColumn: string;
+    filterPlaceholder: string;
+    removeRows: string;
+    showLabel: string;
+    entriesLabel: string;
+    entriesOnPageLabel: string;
+    visualizer_text: string;
+    visualizer_wordcloud: string;
+    visualizer_histogram: string;
+    visualizer_number: string;
+    visualizer_average: string;
+    visualizer_choices: string;
+    visualizer_selectBase: string;
+    visualizer_matrix: string;
+    chartType_bar: string;
+    chartType_vbar: string;
+    chartType_stackedbar: string;
+    chartType_doughnut: string;
+    chartType_pie: string;
+    chartType_scatter: string;
+    chartType_gauge: string;
+    chartType_bullet: string;
+    chartType_line: string;
+    chartType_radar: string;
+    chartType_histogram: string;
+    chartType_vhistogram: string;
+    chartType_stackedhistogram: string;
+    hideButton: string;
+    makePrivateButton: string;
+    makePublicButton: string;
+    showButton: string;
+    filter: string;
+    resetFilter: string;
+    changeLocale: string;
+    clearButton: string;
+    addElement: string;
+    allQuestions: string;
+    defaultOrder: string;
+    ascOrder: string;
+    descOrder: string;
+    showMinorColumns: string;
+    actionsColumn: string;
+    otherCommentTitle: string;
+    showPercentages: string;
+    hidePercentages: string;
+    exportAs: string;
+    pdfDownloadCaption: string;
+    xlsxDownloadCaption: string;
+    csvDownloadCaption: string;
+    saveDiagramAsPNG: string;
+    responsesText: string;
+    noData: string;
+    selectDateRange: string;
+    includeToday: string;
+    reportingPeriodCustom: string;
+    reportingPeriodLast7days: string;
+    reportingPeriodLast14days: string;
+    reportingPeriodLast28days: string;
+    reportingPeriodLast30days: string;
+    reportingPeriodLastWeekMon: string;
+    reportingPeriodLastWeekSun: string;
+    reportingPeriodLastMonth: string;
+    reportingPeriodLastQuarter: string;
+    reportingPeriodLastYear: string;
+    reportingPeriodWtdSun: string;
+    reportingPeriodWtdMon: string;
+    reportingPeriodMtd: string;
+    reportingPeriodQtd: string;
+    reportingPeriodYtd: string;
+    hideEmptyAnswers: string;
+    showEmptyAnswers: string;
+    "topNValueText-1": string;
+    topNValueText5: string;
+    topNValueText10: string;
+    topNValueText20: string;
+    hideMissingAnswers: string;
+    showMissingAnswers: string;
+    missingAnswersLabel: string;
+    noVisualizerForQuestion: string;
+    noResults: string;
+    showPerValues: string;
+    showPerColumns: string;
+    answer: string;
+    correctAnswer: string;
+    percent: string;
+    percentage: string;
+    statistics_chart: string;
+    responses: string;
+    visualizer_nps: string;
+    visualizer_boolean: string;
+    visualizer_options: string;
+    npsScore: string;
+    npsPromoters: string;
+    npsPassives: string;
+    npsDetractors: string;
+    axisXSelectorTitle: string;
+    axisYSelectorTitle: string;
+    axisXAlternativeSelectorTitle: string;
+    axisYAlternativeSelectorTitle: string;
+    notSelected: string;
+    intervalMode_default: string;
+    intervalMode_decades: string;
+    intervalMode_years: string;
+    intervalMode_quarters: string;
+    intervalMode_months: string;
+    intervalMode_days: string;
+    intervalMode_custom: string;
+    intervalMode_auto: string;
+    intervalModeTitle: string;
+    noRunningTotals: string;
+    runningTotals: string;
+    groupDateSeries: string;
+    ungroupDateSeries: string;
+    noneAggregateText: string;
+    selectAggregateText: string;
+    groupedYearsAxisTitle: string;
+    license: string;
+    license2: string;
+};
+export declare function setupLocale(localeConfig: {
+    localeCode: string;
+    strings: any;
+    nativeName?: string;
+}): void;

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

@@ -0,0 +1,17 @@
+import { ItemValue, QuestionMatrixModel, Question } from "survey-core";
+import { SelectBase } from "./selectBase";
+import { IAnswersData } from "./visualizerBase";
+export declare class Matrix extends SelectBase {
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: Object, type?: string);
+    protected get matrixQuestion(): QuestionMatrixModel;
+    protected isSupportMissingAnswers(): boolean;
+    getSeriesValues(): Array<string>;
+    getSeriesLabels(): Array<string>;
+    getSelectedItemByText(itemText: string): any;
+    valuesSource(): Array<ItemValue>;
+    private getHasAnswersInAllSeriesArray;
+    private getHasAnswersInSeries;
+    protected hideEmptyAnswersInData(answersData: IAnswersData): IAnswersData;
+}

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

@@ -0,0 +1,15 @@
+import { ItemValue, QuestionMatrixDropdownModel, Question } from "survey-core";
+import { SelectBase } from "./selectBase";
+import { ICalculationResult } from "./visualizerBase";
+export declare class MatrixDropdownGrouped extends SelectBase {
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: Object, type?: string);
+    protected get matrixQuestion(): QuestionMatrixDropdownModel;
+    get dataNames(): Array<string>;
+    getSeriesValues(): Array<string>;
+    getSeriesLabels(): Array<string>;
+    valuesSource(): Array<ItemValue>;
+    protected isSupportMissingAnswers(): boolean;
+    protected getCalculatedValuesCore(): ICalculationResult;
+}

package/survey-analytics-plotly.types/muuri-layout-engine.d.ts

@@ -0,0 +1,13 @@
+import { LayoutEngine } from "./layout-engine";
+export declare class MuuriLayoutEngine extends LayoutEngine {
+    private _selector;
+    private dragEnabled;
+    private _muuri;
+    private _layoutingTimer;
+    constructor(allowed: boolean, _selector: string, dragEnabled?: boolean);
+    protected startCore(container: HTMLElement): void;
+    protected stopCore(): void;
+    protected updateCore(): void;
+    add(elements: Array<HTMLElement>, options?: any): void;
+    remove(elements: Array<HTMLElement>, options?: any): void;
+}

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

@@ -0,0 +1,37 @@
+import { Question } from "survey-core";
+import { ICalculationResult, VisualizerBase } from "./visualizerBase";
+import "./nps.scss";
+export declare class NpsVisualizerWidget {
+    private _model;
+    private _renderedTarget;
+    private _data;
+    constructor(_model: NpsVisualizer, data: ICalculationResult);
+    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 _npsVisualizer;
+    constructor(model: NpsVisualizer);
+    get npsVisualizer(): any;
+    create(element: HTMLElement): Promise<any>;
+    destroy(node: HTMLElement): void;
+}
+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, type?: string);
+    protected getCalculatedValuesCore(): ICalculationResult;
+    protected destroyContent(container: HTMLElement): void;
+    protected renderContentAsync(container: HTMLElement): Promise<HTMLElement>;
+    destroy(): void;
+}

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

@@ -0,0 +1,27 @@
+import { Question } from "survey-core";
+import { ICalculationResult, VisualizerBase } from "./visualizerBase";
+export declare class NumberModel extends VisualizerBase {
+    private _statistics;
+    static stepsCount: number;
+    static generateTextsCallback: (question: Question, maxValue: number, minValue: number, stepsCount: number, texts: string[]) => string[];
+    protected chartTypes: Array<string>;
+    chartType: String;
+    static showAsPercentage: boolean;
+    displayValueName: string;
+    private initChartTypes;
+    constructor(question: Question, data: Array<{
+        [index: string]: any;
+    }>, options?: {
+        [index: string]: any;
+    }, type?: string);
+    protected onDataChanged(): void;
+    protected onChartTypeChanged(): void;
+    protected setChartType(chartType: string): void;
+    destroy(): void;
+    generateText(maxValue: number, minValue: number, stepsCount: number): string[];
+    generateValues(maxValue: number, stepsCount: number): number[];
+    generateColors(maxValue: number, minValue: number, stepsCount: number): string[];
+    convertFromExternalData(externalCalculatedData: any): ICalculationResult;
+    protected getCalculatedValuesCore(): ICalculationResult;
+    getValues(): Array<any>;
+}

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

@@ -0,0 +1,59 @@
+import { Question } from "survey-core";
+import { ICalculationResult, IVisualizerOptions } from "./visualizerBase";
+import { HistogramModel } from "./histogram";
+export interface IPivotChartVisualizerOptions extends IVisualizerOptions {
+    questions?: Question[] | string[];
+    categoryField?: Question | string;
+    seriesFields?: Question[] | string[];
+    maxSeriesCount?: number;
+    [key: string]: any;
+}
+export declare class PivotModel extends HistogramModel {
+    questions: Array<Question>;
+    private isRoot;
+    private _pivotContinuousData;
+    private axisXSelector;
+    axisXQuestionName: string;
+    private axisYSelectors;
+    axisYQuestionNames: Array<string>;
+    private questionsY;
+    private _questionDefinition;
+    private _aggregations;
+    constructor(questions: Array<Question>, data: Array<{
+        [index: string]: any;
+    }>, options?: IPivotChartVisualizerOptions, isRoot?: boolean, type?: string);
+    protected getName(): string;
+    protected getTitle(question: Question): string;
+    private createYSelecterGenerator;
+    setAxisQuestions(...axisQuestionNames: string[]): void;
+    onAxisYSelectorChanged(index: number, value: any): void;
+    protected updateQuestionsSelection(): void;
+    private createAxisYSelector;
+    protected setChartType(chartType: string): void;
+    private isXYChart;
+    private setupPivot;
+    protected getContinuousValues(): {
+        original: any;
+        continuous: number;
+        row: any;
+    }[];
+    protected isSupportAnswersOrder(): boolean;
+    getSeriesValues(): Array<string>;
+    getSeriesLabels(): Array<string>;
+    convertFromExternalData(externalCalculatedData: any): ICalculationResult;
+    getSeriesValueIndexes(): {
+        [index: string]: number;
+    };
+    updateStatisticsSeriesValue(statistics: Array<Array<number>>, dataRow: {
+        [index: string]: any;
+    }, valueIndex: number, seriesValueIndexes: {
+        [index: string]: number;
+    }): void;
+    resetAggregations(): void;
+    setValueAggregation(axisYQuestion: string, aggregation: string | ((acc: number, value: number) => number)): void;
+    protected calculateAggregation(dataRow: any, axisYQuestion: string, currentValue: number): number;
+    protected getCalculatedValuesCore(): ICalculationResult;
+    protected renderToolbar(container: HTMLElement): void;
+    render(targetElement: HTMLElement | string, isRoot?: boolean): void;
+    protected renderBanner(container: HTMLElement): void;
+}

package/{survey-analytics.types → survey-analytics-plotly.types}/plotly/chart-adapter.d.ts

@@ -1,11 +1,20 @@
 import { SelectBase } from "../selectBase";
 import { VisualizerBase, IChartAdapter } from "../visualizerBase";
-export declare const plotlyChartTypes: {
-    [key: string]: () => Array<string>;
+export declare const chartTypes: {
+    boolean: string[];
+    number: string[];
+    average: string[];
+    selectBase: string[];
+    histogram: string[];
+    matrix: string[];
+    matrixDropdownGrouped: string[];
+    pivot: string[];
+    ranking: string[];
 };
 export declare class PlotlyChartAdapter implements IChartAdapter {
     protected model: SelectBase | VisualizerBase;
     private _chart;
+    static getChartTypesByVisualizerType(vType: string): Array<string>;
     constructor(model: SelectBase | VisualizerBase);
     protected patchConfigParameters(chartNode: object, traces: Array<object>, layout: object, config: any): void;
     get chart(): Promise<Plotly.PlotlyHTMLElement>;

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

@@ -0,0 +1,150 @@
+import { Event } from "survey-core";
+import { SelectBase } from "../selectBase";
+import { IAnswersData, VisualizerBase } from "../visualizerBase";
+import { NumberModel } from "../number";
+import { DashboardTheme } from "../theme";
+export interface PlotlyOptions {
+    traces: Array<any>;
+    layout: any;
+    hasSeries: boolean;
+}
+export declare class PlotlySetup {
+    static imageExportFormat: string;
+    static defaultBarGap: number;
+    static getRgbaColor(propertyValue: any): string;
+    static defaultModebarConfig(theme: DashboardTheme): {
+        bgcolor: string;
+        activecolor: string;
+        color: string;
+    };
+    static defaultTooltipConfig(theme: DashboardTheme): {
+        bgcolor: string;
+        font: {
+            size: number;
+            family: string;
+            color: string;
+            weight: number;
+        };
+    };
+    static defaultLegendConfig(model: SelectBase): {
+        orientation: string;
+        xanchor: string;
+        yanchor: string;
+        x: number;
+        y: number;
+        bordercolor: any;
+        borderwidth: any;
+        itemwidth: number;
+        font: {
+            size: number;
+            family: string;
+            color: string;
+            weight: number;
+        };
+    };
+    static defaultAxisConfig(theme: DashboardTheme): {
+        zerolinecolor: string;
+        automargin: boolean;
+        tickfont: {
+            size: number;
+            family: string;
+            color: string;
+            weight: number;
+        };
+    };
+    static defaultInsideLabelFont(theme: DashboardTheme): {
+        size: number;
+        family: string;
+        color: string;
+        weight: number;
+    };
+    static defaultAxisXConfig(theme: DashboardTheme): {
+        ticklabelstandoff: number;
+        zerolinecolor: string;
+        automargin: boolean;
+        tickfont: {
+            size: number;
+            family: string;
+            color: string;
+            weight: number;
+        };
+    };
+    static defaultAxisXWithGridLineConfig(theme: DashboardTheme): {
+        gridcolor: string;
+        griddash: string;
+        ticklabelstandoff: number;
+        zerolinecolor: string;
+        automargin: boolean;
+        tickfont: {
+            size: number;
+            family: string;
+            color: string;
+            weight: number;
+        };
+    };
+    static defaultAxisYConfig(theme: DashboardTheme): {
+        ticklabelstandoff: number;
+        zerolinecolor: string;
+        automargin: boolean;
+        tickfont: {
+            size: number;
+            family: string;
+            color: string;
+            weight: number;
+        };
+    };
+    static defaultAxisYWithGridLineConfig(theme: DashboardTheme): {
+        gridcolor: string;
+        griddash: string;
+        ticklabelstandoff: number;
+        zerolinecolor: string;
+        automargin: boolean;
+        tickfont: {
+            size: number;
+            family: string;
+            color: string;
+            weight: number;
+        };
+    };
+    static defaultGaugeConfig(theme: any): {
+        bgcolor: string;
+        bordercolor: string;
+        bar: {
+            color: string;
+            thickness: number;
+        };
+    };
+    static defaultValueGaugeFont(theme: DashboardTheme): {
+        size: number;
+        family: string;
+        color: string;
+        weight: number;
+    };
+    static defaultGaugeTickFont(theme: DashboardTheme): {
+        size: number;
+        family: string;
+        color: string;
+        weight: number;
+    };
+    static noDataAnnotations(theme: DashboardTheme): any;
+    /**
+     * Fires when end user clicks on the 'save as image' button.
+     */
+    static onImageSaving: Event<(sender: VisualizerBase, options: any) => any, VisualizerBase, 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: VisualizerBase, answersData: IAnswersData) => PlotlyOptions;
+    };
+    static setup(charType: string, model: VisualizerBase, answersData: IAnswersData): PlotlyOptions;
+    static getTruncatedLabel: (label: string, labelTruncateLength: number) => string;
+    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;
+    static setupGauge(model: NumberModel, answersData: IAnswersData): PlotlyOptions;
+    static setupRadar(model: SelectBase, answersData: IAnswersData): PlotlyOptions;
+}

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

@@ -0,0 +1,12 @@
+import { SelectBase } from "./selectBase";
+import { QuestionRankingModel } from "survey-core";
+import { ICalculationResult } from "./visualizerBase";
+export declare class RankingModel extends SelectBase {
+    constructor(question: QuestionRankingModel, data: Array<{
+        [index: string]: any;
+    }>, options?: any, type?: string);
+    getQuestionResults(): any[];
+    getEmptyData(): any;
+    protected getCalculatedValuesCore(): ICalculationResult;
+    applyResultToPlotlyData(result: any[], plotlyData: any, choices: any): void;
+}