VisualizationPanel
An object that visualizes survey results and allows users to analyze them.
Constructor parameters:
questions
: Array<Question
>
Survey questions to visualize. CallSurveyModel
'sgetAllQuestions()
method to access all survey questions and pass its result as thequestions
parameter.data
:Array<any>
Survey results.options
:IVisualizationPanelOptions
Visualization Panel configuration.
Inherited from the following class(es):
Properties
Methods
Returns the allowDynamicLayout
property value of the IVisualizationPanelOptions
object.
- Type:
- boolean readonly
- Implemented in:
- VisualizationPanel
Returns the allowHideQuestions
property value of the IVisualizationPanelOptions
object.
- Type:
- boolean readonly
- Implemented in:
- VisualizationPanel
Empties the toolbar, header, footer, and content containers.
If you want to empty and delete the visualizer and all its elements from the DOM, call the destroy()
method instead.
- Type:
- () => void
- Implemented in:
- VisualizerBase
Returns an array of survey results used to calculate values for visualization. If a user applies a filter, the array is also filtered.
To get an array of calculated and visualized values, call the getData()
method.
- Type:
- any readonly
- Implemented in:
- VisualizerBase
Deletes the visualizer and all its elements from the DOM.
- Type:
- () => void
- Implemented in:
- VisualizerBase
- See also:
- clear
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 data
property.
- Type:
- () => any
- Implemented in:
- VisualizerBase
Returns panel element description by the question name.
- Type:
- (name: string) => any
- Parameters:
-
name, type: string
- Implemented in:
- VisualizationPanel
Returns an array of IVisualizerPanelElement
objects with information about visualization items.
- Type:
- () => {}
- Implemented in:
- VisualizationPanel
- See also:
- visibleElements * , hiddenElements
Returns an object with properties that describe a current visualizer state. The properties are different for each individual visualizer.
This method is overriden in descendant classes.
- Type:
- () => any
- Implemented in:
- VisualizerBase
- See also:
- setState
Returns a visualizer that visualizes a specified survey question.
- Type:
- (questionName: string) => any
- Parameters:
- Implemented in:
- VisualizationPanel
Indicates whether the visualizer displays a header. This property is true
when a visualized question has a correct answer.
- Type:
- boolean readonly
- Implemented in:
- VisualizerBase
- See also:
- hasFooter
Returns a LayoutEngine
instance used to arrange visualization items on VisualizationPanel
.
- Type:
- LayoutEngine readonly
- Implemented in:
- VisualizationPanel
Gets or sets the current locale.
If you want to inherit the locale from a visualized survey, assign a SurveyModel
instance to the survey
property of the options
object in the constructor.
If the survey is translated into more than one language, the toolbar displays a language selection drop-down menu.
- Type:
- string writable
- Implemented in:
- VisualizerBase
- See also:
- onLocaleChanged
An event that is raised after the visualizer's content is rendered.
Parameters:
sender
:VisualizerBase
AVisualizerBase
instance that raised the event.options.htmlElement
:HTMLElement
A page element with the visualizer's content.
- Type:
- Event<(sender: VisualizerBase, options: any) => any, VisualizerBase, any>
- Implemented in:
- VisualizerBase
- See also:
- render * , refresh **
An event that is raised when a user selects a different visualizer type from the Type drop-down menu.
Parameters:
sender
:AlternativeVisualizersWrapper
An object that controls altenative visualizers.options.visualizer
:VisualizerBase
An applied visualizer.
- Type:
- Event<(sender: AlternativeVisualizersWrapper, options: any) => any, AlternativeVisualizersWrapper, any>
- Implemented in:
- VisualizationPanel
An event that is raised after a new locale is set.
Parameters:
sender
:VisualizerBase
AVisualizerBase
instance that raised the event.options.locale
:String
The indentifier of a new locale (for example, "en").
- Type:
- Event<(sender: VisualizerBase, options: { locale: string; }) => any, VisualizerBase, any>
- Implemented in:
- VisualizerBase
- See also:
- locale
An event that is raised when users move a visualization item or toggle its visibility.
Parameters:
sender
:VisualizationPanel
AVisualizationPanel
that raised the event.options.elements
: Array<IVisualizerPanelElement
>
Information about visualization items rendered by thisVisualizationPanel
.options.changed
:IVisualizerPanelElement
A visualization item that has been changed.options.reason
:"ADDED"
|"REMOVED"
|"MOVED"
Indicates the reason why the event has been raised.
- Type:
- Event<(sender: VisualizationPanel, options: any) => any, VisualizationPanel, any>
- Implemented in:
- VisualizationPanel
Redraws the VisualizationPanel
and all its content.
- Type:
- () => void
- Implemented in:
- VisualizationPanel
Registers a function used to create a toolbar item for this visualizer.
- Type:
- (name: string, creator: (toolbar?: any) => any) => void
- Parameters:
-
name, type: string ,
A custom name for the toolbar item.
creator, type: (toolbar?: any) => any ,A function that accepts the toolbar and should return an
HTMLElement
with the toolbar item.
- Implemented in:
- VisualizerBase
Renders the visualizer in a specified container.
- Type:
- (targetElement: any) => void
- Parameters:
-
targetElement, type: any ,
An
HTMLElement
or anid
of a page element in which you want to render the visualizer.
- Implemented in:
- VisualizerBase
Filters visualized data based on a specified question name and value. This method is called when a user clicks a chart point.
- Type:
- (questionName: string, selectedValue: any) => void
- Parameters:
-
selectedValue, type: any
- Implemented in:
- VisualizationPanel
Sets the visualizer's state.
This method is overriden in descendant classes.
- Type:
- (state: any) => void
- Parameters:
-
state, type: any
- Implemented in:
- VisualizerBase
- See also:
- getState
Gets or sets the visibility of the visualizer's toolbar.
Default value: true
- Type:
- boolean writable
- Implemented in:
- VisualizerBase
Indicates whether users can select series points to cross-filter charts. To allow or disallow selection, set the allowSelection
property of the options
object in the constructor.
- Type:
- boolean readonly
- Implemented in:
- VisualizerBase
Updates visualized data.
- Type:
- (data: any) => void
- Parameters:
-
data, type: any ,
A data array with survey results to be visualized.
- Implemented in:
- VisualizerBase
Returns an array of IVisualizerPanelElement
objects with information about currently visible visualization items.
If you want to disallow users to hide visualization items, set the allowHideQuestions
property to false
.
- Type:
- any readonly
- Implemented in:
- VisualizationPanel
- See also:
- hiddenElements * , getElements
Copyright © 2023 Devsoft Baltic OÜ. All rights reserved.