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

SurveyJS analytics Library.

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<{
            ctor: VisualizerConstructor;
            index: number;
        }>;
    };
    /**
     * 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.
     * @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): 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 | 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 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 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;
}
export {};