VisualizationPanel, SurveyJS Creator Documentation

VisualizationPanel is responsible for visualizing an array of survey questions

constructor parameters: questions - an array of survey questions to visualize, data - an array of answers in format of survey result, options - object with the following options, elements - list of visual element descriptions

options: allowDynamicLayout - set it to false to disable items drag/drop reordering and dynamic layouting, labelTruncateLength - the length of the label where the truncation starts. Set to -1 to disable truncate. Default is 27. allowHideQuestions - set it to false to deny user to hide/show individual questions, allowMakeQuestionsPrivate - set it to true to allow make elements private/public also see persmissions property, seriesValues - an array of series values in data to group data by series, seriesLabels - labels for series to display, if not passed the seriesValues are used as labels, survey - pass survey instance to use localses from the survey JSON, dataProvider - dataProvider for this visualizer, layoutEngine - layout engine to be used for layouting inner visualizers

Inherited from the following class(es):

VisualizerBase

IDataInfo

Type to filter the list:

	allowDynamicLayout property
	Returns whether the VisualizationPanel allows dynamic layouting - rearrange items via drap/drop. Set via options. Type: boolean readonly Implemented in: VisualizationPanel
	allowHideQuestions property
	Returns whether the VisualizationPanel allows to hide/show individual inner visualizers. Type: boolean readonly Implemented in: VisualizationPanel
	allowMakeQuestionsPrivate property
	Returns whether the VisualizationPanel allows to make private/public individual inner visualizers for work with permissions. Type: boolean readonly Implemented in: VisualizationPanel
	clear method
	Method for clearing all rendered elements from outside. Type: () => void Implemented in: VisualizationPanel
	getElement method
	Returns panel element description by the question name. Type: (name: string) => IVisualizerPanelRenderedElement Parameters: name, type: string Implemented in: VisualizationPanel
	getElements method
	Returns panel elements descriptions array. Inner visualizers are rendered in the order of this array and with titles from the displayName property Type: () => IVisualizerPanelElement[] Implemented in: VisualizationPanel
	hiddenElements property
	Returns panel's hidden elements. Type: IVisualizerPanelRenderedElement[] readonly Implemented in: VisualizationPanel
	layout method
	Updates layout of visualizer inner content. Type: () => void Implemented in: VisualizationPanel
	layoutEngine property
	Returns the layout engine instance if any. Type: LayoutEngine readonly Implemented in: VisualizationPanel
	locale property
	Returns current locale of the visualization panel. If locales more than one, the language selection dropdown will be added in the toolbar In order to use survey locales the survey instance object should be passed as 'survey' option for visualizer Sets locale for visualization panel. Type: string writable Implemented in: VisualizationPanel
	name property
	The name of the visaulizer. Type: string readonly Implemented in: VisualizerBase
	onAfterRender event
	The event is fired right after a visualizer's content is rendered in DOM. Type: Event<(sender: VisualizerBase, options: any) => any, any> Implemented in: VisualizerBase
	onPermissionsChangedCallback property
	Fires when permissions changed Type: any readonly Implemented in: VisualizationPanel
	onStateChanged event
	Fires when vizualization panel state changed. sender - this panel state - new state of the panel Type: Event<(sender: VisualizationPanel, state: IState) => any, any> Implemented in: VisualizationPanel
	onVisibleElementsChanged event
	Fires when element visibility has been changed. options: elements - panel elements array changed - changed element reason - reason (string) why event fired: "ADDED", "MOVED" or "REMOVED" Type: Event<(sender: VisualizationPanel, options: any) => any, any> Implemented in: VisualizationPanel
	permissions property
	Gets vizualization panel permissions. Sets vizualization panel permissions. Type: IPermission[] writable Implemented in: VisualizationPanel
	privateElements property
	Returns panel's private elements. Type: IVisualizerPanelRenderedElement[] readonly Implemented in: VisualizationPanel
	publicElements property
	Returns panel's public elements. Type: IVisualizerPanelRenderedElement[] readonly Implemented in: VisualizationPanel
	refresh method
	Redraws visualizer and all inner content. Type: () => void Implemented in: VisualizerBase
	refresh method
	Redraws visualizer toobar and all inner content. Type: () => void Implemented in: VisualizationPanel
	registerToolbarItem method
	Registers creator of visualizer toolbar item. Type: (name: string, creator: (toolbar?: HTMLDivElement) => HTMLElement) => void Parameters: name, type: string creator, type: (toolbar?: HTMLDivElement) => HTMLElement Implemented in: VisualizerBase
	renderContent method
	Renders all questions into given HTML container element. container - HTML element to render the panel Type: (container: HTMLElement) => void Parameters: container, type: HTMLElement Implemented in: VisualizationPanel
	setFilter method
	Sets filter by question name and value. Type: (questionName: string, selectedValue: any) => void Parameters: questionName, type: string selectedValue, type: any Implemented in: VisualizationPanel
	state property
	Gets vizualization panel state. Sets vizualization panel state. Type: IState writable Implemented in: VisualizationPanel
	supportSelection property
	Indicates whether visualizer supports selection. Visualizers of questions with choices allow to select choice by clicking on the diagram bar and filter other data for the selected item. Type: boolean readonly Implemented in: VisualizerBase
	visibleElements property
	Returns panel's visible elements. Type: IVisualizerPanelRenderedElement[] readonly Implemented in: VisualizationPanel

VisualizationPanel

Why We Use Cookies