survey-analytics 2.5.14 → 3.0.0-beta.0

package/survey-analytics-plotly.types/utils/calculationDateRanges.d.ts

@@ -0,0 +1,35 @@
+export interface IDateRange {
+    start?: number;
+    end?: number;
+}
+export declare function startOfDay(d: Date): Date;
+export declare function endOfDay(d: Date): Date;
+export declare function toRange(start: Date | number, end: Date | number): IDateRange;
+/** Last 7 days (excl. today): refDate minus 7 days through yesterday */
+export declare function getLast7Days(refDate?: Date): IDateRange;
+/** Last 14 days (excl. today): refDate minus 14 days through yesterday */
+export declare function getLast14Days(refDate?: Date): IDateRange;
+/** Last 28 days (excl. today): refDate minus 28 days through yesterday */
+export declare function getLast28Days(refDate?: Date): IDateRange;
+/** Last 30 days (excl. today): refDate minus 30 days through yesterday */
+export declare function getLast30Days(refDate?: Date): IDateRange;
+/** Last week (Monday-Sunday): previous Monday through previous Sunday */
+export declare function getLastWeekMon(refDate?: Date): IDateRange;
+/** Last week (Sunday-Saturday): previous Sunday through previous Saturday */
+export declare function getLastWeekSun(refDate?: Date): IDateRange;
+/** Last month: first day through last day of previous month */
+export declare function getLastMonth(refDate?: Date): IDateRange;
+/** Last quarter: first day through last day of previous quarter */
+export declare function getLastQuarter(refDate?: Date): IDateRange;
+/** Last year: January 1 through December 31 of previous year */
+export declare function getLastYear(refDate?: Date): IDateRange;
+/** This week to date (starts Sunday): Sunday through yesterday or today */
+export declare function getThisWeekToDateSun(refDate?: Date, includeToday?: boolean): IDateRange;
+/** This week to date (starts Monday): Monday through yesterday or today */
+export declare function getThisWeekToDateMon(refDate?: Date, includeToday?: boolean): IDateRange;
+/** This month to date: first day of month through yesterday or today */
+export declare function getThisMonthToDate(refDate?: Date, includeToday?: boolean): IDateRange;
+/** This quarter to date: first day of quarter through yesterday or today */
+export declare function getThisQuarterToDate(refDate?: Date, includeToday?: boolean): IDateRange;
+/** This year to date: January 1 through yesterday or today */
+export declare function getThisYearToDate(refDate?: Date, includeToday?: boolean): IDateRange;

package/survey-analytics-plotly.types/utils/dateRangeModel.d.ts

@@ -0,0 +1,32 @@
+import { IDateRange } from "./calculationDateRanges";
+export type DatePeriodEnum = "last7days" | "last14days" | "last28days" | "last30days" | "lastWeekMon" | "lastWeekSun" | "lastMonth" | "lastQuarter" | "lastYear" | "ytd" | "mtd" | "wtdSun" | "wtdMon" | "qtd";
+export type DateRangeTuple = [startDate: Date | number, endDate: Date | number];
+export declare const datePeriodsFunctions: Partial<Record<DatePeriodEnum, (refDate?: Date, includeToday?: boolean) => IDateRange>>;
+export interface IDateRangeChangedOptions {
+    datePeriod?: DatePeriodEnum;
+    dateRange?: DateRangeTuple;
+}
+export interface IDateRangeModelOptions {
+    onDateRangeChanged: (dateRange: IDateRange, datePeriod: DatePeriodEnum) => void;
+    datePeriod?: DatePeriodEnum;
+    availableDatePeriods?: Array<DatePeriodEnum>;
+    dateRange?: DateRangeTuple;
+    includeToday?: boolean;
+}
+export declare class DateRangeModel {
+    private _currentDatePeriod;
+    private _currentDateRange;
+    private _availableDatePeriods;
+    private _onDateRangeChanged;
+    private _includeToday;
+    constructor(options: IDateRangeModelOptions);
+    get currentDatePeriod(): DatePeriodEnum;
+    get currentDateRange(): IDateRange;
+    get availableDatePeriods(): Array<DatePeriodEnum>;
+    get includeToday(): boolean;
+    set includeToday(newValue: boolean);
+    toggleIncludeToday(): void;
+    setDatePeriod(datePeriod: DatePeriodEnum | undefined): void;
+    setFilter(start: number, end: number, isCustom?: boolean): void;
+    periodIsToDate(): boolean;
+}

package/survey-analytics-plotly.types/utils/dateRangeWidget.d.ts

@@ -0,0 +1,38 @@
+import { DateRangeModel, DatePeriodEnum, datePeriodsFunctions, IDateRangeModelOptions } from "./dateRangeModel";
+import "./dateRangeWidget.scss";
+export type { DatePeriodEnum };
+export { datePeriodsFunctions };
+export interface IDateRangeWidgetOptions extends IDateRangeModelOptions {
+    showAnswerCount?: boolean;
+}
+export declare class DateRangeWidget {
+    private model;
+    private options;
+    static invalidRangeClassName: string;
+    static invalidRangeEditorClassName: string;
+    private dateRangeContainer;
+    private startDateEditor;
+    private endDateEditor;
+    private startDateInput;
+    private endDateInput;
+    private countLabel;
+    private rangeErrorMessage;
+    private datePeriodContainer;
+    private includeTodayContainer;
+    private includeTodayCheckbox;
+    private answersCount;
+    private elementRemoveClassName;
+    private updateMinMaxAttributes;
+    private setDateIntoInput;
+    private createErrorMessage;
+    private createDateEditor;
+    private createDivider;
+    private createIncludeTodayCheckbox;
+    private updateIncludeTodayCheckbox;
+    constructor(model: DateRangeModel, options: IDateRangeWidgetOptions);
+    render(): HTMLElement;
+    setDatePeriod(datePeriod: DatePeriodEnum | undefined): void;
+    updateElements(): void;
+    updateAnswersCount(answersCount?: number): void;
+    destroy(): void;
+}

package/survey-analytics-plotly.types/utils/dropdownActionWidget.d.ts

@@ -0,0 +1,31 @@
+import { DropdownBase, IDropdownItemOption } from "./dropdownBase";
+export interface IActionDropdownOptions {
+    options: Array<IDropdownItemOption> | (() => Array<IDropdownItemOption>);
+    isSelected: (option: {
+        value: string;
+        text: string;
+        icon?: string;
+    }) => boolean;
+    handler: (value: string) => boolean;
+    title: string | (() => string) | Function;
+    className?: string;
+    showArrow?: boolean;
+    direction?: "up" | "down";
+}
+export declare class ActionDropdownWidget extends DropdownBase {
+    private options;
+    private headerText;
+    constructor(options: IActionDropdownOptions);
+    get direction(): "up" | "down";
+    protected createHeader(): HTMLDivElement;
+    private getTitleText;
+    protected getOptions(): IDropdownItemOption[];
+    protected isOptionSelected(option: IDropdownItemOption): boolean;
+    protected onOptionSelect(option: IDropdownItemOption, dropdownItem: HTMLLIElement): void;
+    protected onBeforePopupShow(): void;
+    private updateHeaderLabel;
+    protected updateSelect(): void;
+    protected attachMethodsToElement(): void;
+    setValues(values: string[]): void;
+    getValues(): string[];
+}

package/survey-analytics-plotly.types/utils/dropdownBase.d.ts

@@ -0,0 +1,47 @@
+export interface IDropdownItemOption {
+    value: string;
+    text: string;
+    title?: string;
+    icon?: string;
+    [key: string]: any;
+}
+export declare abstract class DropdownBase {
+    protected className: string;
+    protected dropdownOpenedClass: string;
+    protected itemClassSelected: string;
+    protected dropdownElement: HTMLDivElement;
+    protected dropdownHeader: HTMLDivElement;
+    protected dropdownList: HTMLUListElement;
+    protected dropdownContainer: HTMLDivElement;
+    protected optionItems: IDropdownItemOption[];
+    protected currentFocusIndex: number;
+    protected handleClickOutsideRef: (event: MouseEvent) => void;
+    constructor(defaultClassName: string);
+    get isOpen(): boolean;
+    render(): HTMLDivElement;
+    protected createDropdownElement(): HTMLDivElement;
+    protected createList(): HTMLUListElement;
+    protected createContainer(): HTMLDivElement;
+    protected createArrow(arrowClassName?: string): HTMLDivElement;
+    protected showPopup(): void;
+    protected hidePopup(): void;
+    protected focusItem(index: number, updateAriaSelected?: boolean): void;
+    protected updateOptions(): void;
+    protected createOptionItem(option: IDropdownItemOption): HTMLLIElement;
+    protected handleOptionClick(e: MouseEvent, option: IDropdownItemOption, dropdownItem: HTMLLIElement): void;
+    protected handleKeyDown(e: KeyboardEvent): void;
+    protected handleClickOutside(event: MouseEvent): void;
+    protected bindEvents(): void;
+    protected handleHeaderClick(e: MouseEvent): void;
+    protected onBeforePopupShow(): void;
+    protected onOpenedByKeyboard(): void;
+    protected onDropdownOpened(): void;
+    protected updateItemSelection(): void;
+    protected shouldUpdateAriaSelectedOnFocus(): boolean;
+    protected abstract createHeader(): HTMLDivElement;
+    protected abstract getOptions(): IDropdownItemOption[];
+    protected abstract isOptionSelected(option: IDropdownItemOption): boolean;
+    protected abstract onOptionSelect(option: IDropdownItemOption, dropdownItem: HTMLLIElement): void;
+    protected abstract updateSelect(): void;
+    protected abstract attachMethodsToElement(): void;
+}

package/survey-analytics-plotly.types/utils/dropdownWidget.d.ts

@@ -0,0 +1,40 @@
+import { DropdownBase, IDropdownItemOption } from "./dropdownBase";
+export interface IDropdownOptions {
+    /** Array of options or function that returns options */
+    options: Array<IDropdownItemOption> | (() => Array<IDropdownItemOption>);
+    /** Function to check if option is selected */
+    isSelected: (option: IDropdownItemOption) => boolean;
+    /** Selection handler */
+    handler: (value: string, option: IDropdownItemOption) => void;
+    /** Placeholder text when no option is selected */
+    placeholder?: string;
+    /** Title text above the dropdown */
+    title?: string | (() => string);
+    /** CSS class name for the dropdown */
+    className?: string;
+    resetHandler?: () => void;
+}
+export declare class DropdownWidget extends DropdownBase {
+    private options;
+    private optionsSource;
+    private placeholder;
+    private titleElement;
+    private headerContent;
+    private selectedOption;
+    constructor(options: IDropdownOptions);
+    protected createHeader(): HTMLDivElement;
+    private createResetButton;
+    private updateTitle;
+    protected getOptions(): IDropdownItemOption[];
+    protected isOptionSelected(option: IDropdownItemOption): boolean;
+    protected onOptionSelect(option: IDropdownItemOption, dropdownItem: HTMLLIElement): void;
+    protected onBeforePopupShow(): void;
+    protected onDropdownOpened(): void;
+    protected onOpenedByKeyboard(): void;
+    protected shouldUpdateAriaSelectedOnFocus(): boolean;
+    protected updateHeaderContent(): void;
+    protected updateSelect(): void;
+    protected attachMethodsToElement(): void;
+    setValue(value: string | null | undefined): void;
+    getValue(): string | null;
+}

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

@@ -0,0 +1,62 @@
+import { IDropdownOptions } from "./dropdownWidget";
+import { IActionDropdownOptions } from "./dropdownActionWidget";
+export declare class DocumentHelper {
+    static createSelector(options: Array<{
+        value: string;
+        text: string;
+    }> | Function, isSelected: (option: {
+        value: string;
+        text: string;
+    }) => boolean, handler: (e: any) => void, title?: string | Function): HTMLDivElement;
+    /**
+     * Creates a custom dropdown element with icon support
+     * @param options - Configuration object for the dropdown
+     * @returns Created dropdown element
+     */
+    static createDropdown(options: IDropdownOptions): HTMLDivElement;
+    static createActionDropdown(options: IActionDropdownOptions): HTMLDivElement;
+    /**
+     * Destroys dropdown and removes all event handlers
+     * @param {HTMLElement} dropdownElement - Root dropdown element
+     */
+    static destroyDropdown(dropdownElement: any): void;
+    static createButton(handler: (e: any) => void, text?: string, className?: string, icon?: string): HTMLDivElement;
+    static setStyles(element: HTMLElement, styles: Record<string, any>): void;
+    static createElement(tagName: string, className?: string, attrs?: any): HTMLElement;
+    static createSvgElement(path: string): SVGSVGElement;
+    static createSvgButton(path: string, title?: 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;
+    static createTextEditor(options?: {
+        showIcon?: boolean;
+        placeholder?: string;
+        className?: string;
+        inputValue?: string;
+        onchange?: (val: any) => void;
+    }): HTMLElement;
+}
+export declare var options: {
+    runningInBrowser: boolean;
+};
+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[][];
+    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;
+export declare function toPrecision(value: number, precision?: number): number;
+export declare function getDiffsFromDefaults(obj: any, defaultObj?: any): any;

package/survey-analytics-plotly.types/utils/toggle.d.ts

@@ -0,0 +1,17 @@
+import "./toggle.scss";
+export declare class ToggleWidget {
+    private toggleHandler;
+    private text?;
+    private toggleElement;
+    private isActive;
+    container: HTMLElement;
+    constructor(toggleHandler: (options: {
+        isActive: boolean;
+    }) => void, text?: string | Function, initialState?: boolean);
+    get title(): string;
+    createWidget(): void;
+    bindEvents(): void;
+    toggle(): void;
+    updateView(): void;
+    setState(state: any): void;
+}

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

@@ -0,0 +1,9 @@
+export declare function reverseAll(labels: string[], seriesLabels: string[], colors: string[], hasSeries: boolean, texts: any[][], datasets: any[][]): {
+    labels: string[];
+    seriesLabels: string[];
+    colors: string[];
+    texts: any[][];
+    datasets: any[][];
+};
+export declare function removeUndefinedProperties(obj: any): void;
+export declare function isAllZeros(arr: Array<number>): boolean;

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

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

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

@@ -0,0 +1,60 @@
+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.
+ *
+ * [How to Implement a Custom Data Visualizer](https://github.com/surveyjs/surveyjs-howtos-and-troubleshooting/blob/main/categories/data-visualization/custom-survey-data-visualizer.md (linkStyle))
+ */
+export declare class VisualizationManager {
+    static defaultVisualizer: any;
+    static alternativesVisualizer: any;
+    static pivotVisualizer: any;
+    static vizualizers: {
+        [index: string]: Array<{
+            ctor: VisualizerConstructor;
+            index: number;
+            visualizerType: string;
+        }>;
+    };
+    /**
+     * Registers a visualizer for a specified question type.
+     *
+     * [How to Implement a Custom Data Visualizer](https://github.com/surveyjs/surveyjs-howtos-and-troubleshooting/blob/main/categories/data-visualization/custom-survey-data-visualizer.md (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.
+     * @param index A zero-based index that specifies the visualizer's position in the visualizer list for the specified question type. Pass `0` to insert the visualizer at the beginning of the list and use it by default. If `index` is not specified, the visualizer is added to the end of the list.
+     */
+    static registerVisualizer(questionType: string, constructor: VisualizerConstructor, index?: number, visualizerType?: string): void;
+    /**
+     * Unregisters a visualizer for a specified question type.
+     * @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 | undefined, constructor: VisualizerConstructor): void;
+    /**
+     * @deprecated Call the [`unregisterVisualizer()`](https://surveyjs.io/dashboard/documentation/api-reference/visualizationmanager#unregisterVisualizer) method instead.
+     * @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 visualizerType A question [type](https://surveyjs.io/form-library/documentation/api-reference/question#getType).
+     */
+    static getVisualizersByType(visualizerType: string, fallbackVisualizerType?: string): VisualizerConstructor[];
+    static getVisualizerNamesByType(visualizerType: string, fallbackVisualizerType?: string): Array<string>;
+    /**
+     * Returns a constructor for an alternative visualizer selector.
+     * @see registerAltVisualizerSelector
+     */
+    static getAltVisualizerSelector(): any;
+    /**
+     * Registers an alternative visualizer selector.
+     * @param constructor A function that returns a constructor for an alternative visualizer selector.
+     */
+    static registerAltVisualizerSelector(constructor: any): void;
+    static getPivotVisualizerConstructor(): any;
+    static registerPivotVisualizer(constructor: any): void;
+}
+export {};

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

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

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

@@ -0,0 +1,8 @@
+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, type?: string);
+    getQuestions(): Question[];
+}