public class | source

RankingQuestion

Extends:

QuestionBase → Question → QuestionWithAnswers → RankingQuestion

Constructor Summary

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

Member Summary

Public Members
public get	answerButtons: boolean Use buttons for answers.	source
public get	captureOrder: boolean Display the question as capture order multi.	source
public get	formValues: *	source
public get	layoutColumns: number Number of columns for answers placement.	source
public get	layoutRows: number Number of rows for answers placement.	source
public get	multiCount: object `{equal:value, max:value, min:value}`	source
public get	otherValues: object `{<answerCode>: <otherValue>}`	source
public get	rankByDrag: boolean Use drag and drop for answers.	source
public get	rankByNumber: boolean Use number inputs for answers.	source
public get	values: object `{<answerCode>: <value>}`	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

Method Summary

Public Methods
public	setOtherValue(answerCode: string, otherValue: string) Set other answer value.	source
public	setValue(answerCode: string, answerValue: string) Select answer for ranking.	source
public	validate(raiseValidationCompleteEvent: boolean, validationRuleFilter: function): QuestionValidationResult Perform question validation (Inherited from QuestionBase.)	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 Constructors

public constructor(model: object) source

Create instance.

Override:

QuestionWithAnswers#constructor

Params:

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

Public Members

public get answerButtons: boolean source

Use buttons for answers.

public get captureOrder: boolean source

Display the question as capture order multi.

public get formValues: * source

Object with values representing question answer for server.

Override:

QuestionBase#formValues

public get layoutColumns: number source

Number of columns for answers placement.

public get layoutRows: number source

Number of rows for answers placement.

public get multiCount: object source

{equal:value, max:value, min:value}

public get otherValues: object source

{<answerCode>: <otherValue>}

public get rankByDrag: boolean source

Use drag and drop for answers.

public get rankByNumber: boolean source

Use number inputs for answers.

public get values: object source

{<answerCode>: <value>}

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. The handler callback function can take parameters. When the handler is called, object will be passed as only parameter. Object has two properties: model - it is question model. changes - object with changes difference.

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. The handler callback function can take parameters. When the handler is called, instance of QuestionValidationResult will be passed as only parameter.

public get validationEvent: Event source

Fired on question validation. Use to implement custom validation logic. The handler callback function can take parameters. When the handler is called, instance of QuestionValidationResult will be passed as only parameter.

public get answerGroups: HeadGroup[] source

The array of answer groups.

public get answers: Answer[] source

The array of answers.

Public Methods

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, answerValue: string) source

Select answer for ranking.

Params:

Name	Type	Attribute	Description
answerCode	string		Answer code.
answerValue	string		Answer value.

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 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[]