public class | source

GridRatingQuestion

Extends:

QuestionBase → Question → QuestionWithAnswers → GridQuestionBase → GridRatingQuestion

Constructor Summary

Public Constructor
public	constructor(model: object) Create instance.

Member Summary

Public Members
public get	carousel: boolean Is it carousel.	source
public get	nonScaleItems: Scale[] Scales not in rating scale; If option "Exclude Non-scored" is enabled, it contains only scales without score, Otherwise it's empty collection.	source
public get	scaleItems: Scale[] Scales in rating scale; If option "Exclude Non-scored" is enabled, it contains only scales with score.	source
public get	customQuestion: CustomQuestion Custom question settings (Inherited from QuestionBase.)	source
public get	customRendering: boolean Is default Confirmit rendering disabled? (Inherited from QuestionBase.)	source
public get	formValues: object Object with values representing question answer for server. (Inherited from QuestionBase.)	source
public get	id: string Question id. (Inherited from QuestionBase.)	source
public get	instruction: string Question instruction. (Inherited from QuestionBase.)	source
public get	isRtl: bool Is right to left language (Inherited from QuestionBase.)	source
public get	text: string Question text. (Inherited from QuestionBase.)	source
public get	title: string Question title. (Inherited from QuestionBase.)	source
public get	triggeredQuestions: Array Array of triggered questions. (Inherited from QuestionBase.)	source
public get	type: string Question type. (Inherited from QuestionBase.)	source
public get	allowValidateOnChange: boolean Get allow auto re-validation on change value. (Inherited from Question.)	source
public set	allowValidateOnChange(value: boolean) Set allow auto re-validation on change value. (Inherited from Question.)	source
public get	changeEvent: Event Fired on answer changes. (Inherited from Question.)	source
public get	readOnly: boolean Is it read-only question. (Inherited from Question.)	source
public get	required: boolean Is question required. (Inherited from Question.)	source
public get	triggeredQuestions: * (Inherited from Question.)	source
public get	validationCompleteEvent: Event Fired on question validation complete. (Inherited from Question.)	source
public get	validationEvent: Event Fired on question validation. (Inherited from Question.)	source
public get	answerGroups: HeadGroup[] The array of answer groups. (Inherited from QuestionWithAnswers.)	source
public get	answers: Answer[] The array of answers. (Inherited from QuestionWithAnswers.)	source
public get	formValues: * (Inherited from GridQuestionBase.)	source
public get	otherValues: Object `{<answerCode>: <otherValue>...}` (Inherited from GridQuestionBase.)	source
public get	scaleGroups: HeadGroup[] The array of answer groups. (Inherited from GridQuestionBase.)	source
public get	scales: Scale[] The array of scales. (Inherited from GridQuestionBase.)	source
public get	values: Object `{<answerCode>: <scaleCode>...}` (Inherited from GridQuestionBase.)	source

Method Summary

Public Methods
public	validate(raiseValidationCompleteEvent: boolean, validationRuleFilter: function): QuestionValidationResult Perform question validation (Inherited from QuestionBase.)	source
public	clearValues() Clear question values. (Inherited from Question.)	source
public	validate(raiseValidationCompleteEvent: boolean, validationRuleFilter: function): QuestionValidationResult Perform question validation. (Inherited from Question.)	source
public	getAnswer(code: string): Answer Get answer by code. (Inherited from QuestionWithAnswers.)	source
public	getAnswerGroup(code: string): HeadGroup Get answer group by code. (Inherited from QuestionWithAnswers.)	source
public	getAnswers(codes: string[]): Answer[] Get answers array by codes array. (Inherited from QuestionWithAnswers.)	source
public	clearValues() Clear question values. (Inherited from GridQuestionBase.)	source
public	getScale(code: string): Scale Get scale by code. (Inherited from GridQuestionBase.)	source
public	getScaleGroup(code: string): HeadGroup Get scale group by code. (Inherited from GridQuestionBase.)	source
public	getScales(codes: string[]): Scale[] Get scales array by codes array. (Inherited from GridQuestionBase.)	source
public	setOtherValue(answerCode: string, otherValue: string) Set other answer value. (Inherited from GridQuestionBase.)	source
public	setValue(answerCode: string, scaleCode: string) Set value for grid. (Inherited from GridQuestionBase.)	source

Public Constructors

public constructor(model: object) source

Create instance.

Override:

GridQuestionBase#constructor

Params:

Name	Type	Attribute	Description
model	object		The instance of the model.

Public Members

public get carousel: boolean source

Is it carousel.

public get nonScaleItems: Scale[] source

Scales not in rating scale; If option "Exclude Non-scored" is enabled, it contains only scales without score, Otherwise it's empty collection.

public get scaleItems: Scale[] source

Scales in rating scale; If option "Exclude Non-scored" is enabled, it contains only scales with score.

public get customQuestion: CustomQuestion source

Custom question settings

public get customRendering: boolean source

Is default Confirmit rendering disabled?

public get formValues: object source

Object with values representing question answer for server.

public get id: string source

Question id.

public get instruction: string source

Question instruction.

public get isRtl: bool source

Is right to left language

public get text: string source

Question text.

public get title: string source

Question title.

public get triggeredQuestions: Array source

Array of triggered questions.

public get type: string source

Question type.

public get allowValidateOnChange: boolean source

Get allow auto re-validation on change value.

public set allowValidateOnChange(value: boolean) source

Set allow auto re-validation on change value.

public get changeEvent: Event source

Fired on answer changes.

public get readOnly: boolean source

Is it read-only question.

public get required: boolean source

Is question required.

public get triggeredQuestions: * source

Array of triggered questions.

Override:

QuestionBase#triggeredQuestions

public get validationCompleteEvent: Event source

Fired on question validation complete. Use to implement custom error handling.

public get validationEvent: Event source

Fired on question validation. Use to implement custom validation logic.

public get answerGroups: HeadGroup[] source

The array of answer groups.

public get answers: Answer[] source

The array of answers.

public get formValues: * source

Object with values representing question answer for server.

Override:

QuestionBase#formValues

public get otherValues: Object source

{<answerCode>: <otherValue>...}

public get scaleGroups: HeadGroup[] source

The array of answer groups.

public get scales: Scale[] source

The array of scales.

public get values: Object source

{<answerCode>: <scaleCode>...}

Public Methods

public validate(raiseValidationCompleteEvent: boolean, validationRuleFilter: function): QuestionValidationResult source

Perform question validation

Params:

Name	Type	Attribute	Description
raiseValidationCompleteEvent	boolean	optional default: true	Raise validationComplete event if true.
validationRuleFilter	function	optional default: null	Custom filter function to apply specific validation rules only.

Return:

QuestionValidationResult

Result of question validation

public clearValues() source

Clear question values.

public validate(raiseValidationCompleteEvent: boolean, validationRuleFilter: function): QuestionValidationResult source

Perform question validation.

Override:

QuestionBase#validate

Params:

Name	Type	Attribute	Description
raiseValidationCompleteEvent	boolean	optional default: true	Raise validationComplete event if true.
validationRuleFilter	function	optional default: null	Custom filter function to apply specific validation rules only.

Return:

QuestionValidationResult

Question validation result.

public getAnswer(code: string): Answer source

Get answer by code.

Params:

Name	Type	Attribute	Description
code	string		Answer code.

Return:

Answer

public getAnswerGroup(code: string): HeadGroup source

Get answer group by code.

Params:

Name	Type	Attribute	Description
code	string		Group code.

Return:

HeadGroup

public getAnswers(codes: string[]): Answer[] source

Get answers array by codes array.

Params:

Name	Type	Attribute	Description
codes	string[]		Array of answer codes.

Return:

Answer[]

public clearValues() source

Clear question values.

Override:

Question#clearValues

public getScale(code: string): Scale source

Get scale by code.

Params:

Name	Type	Attribute	Description
code	string		Scale code.

Return:

Scale

public getScaleGroup(code: string): HeadGroup source

Get scale group by code.

Params:

Name	Type	Attribute	Description
code	string		Group code.

Return:

HeadGroup

public getScales(codes: string[]): Scale[] source

Get scales array by codes array.

Params:

Name	Type	Attribute	Description
codes	string[]		Array of scale codes.

Return:

Scale[]

Scales array.

public setOtherValue(answerCode: string, otherValue: string) source

Set other answer value.

Params:

Name	Type	Attribute	Description
answerCode	string		Answer code.
otherValue	string		Other value.

public setValue(answerCode: string, scaleCode: string) source

Set value for grid.

Params:

Name	Type	Attribute	Description
answerCode	string		Answer code.
scaleCode	string		Scale code.