public class | source

SearchableSingleQuestion

Mixin Extends:

SingleQuestion, SearchableQuestionMixin

Constructor Summary

Public Constructor
public

constructor(model: object, searchableAnswerListService: SearchableAnswerListService)

Create instance.

Member Summary

Public Members
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

Array of triggered questions.

(Inherited from QuestionBase.)
 source
public get

type: string

Question type.

(Inherited from QuestionBase.)
 source
public get

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

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
(Inherited from Question.)
 source
public get

Fired on question validation complete.

(Inherited from Question.)
 source
public get

Fired on question validation.

(Inherited from Question.)
 source
public get

answerGroups: HeadGroup[]

The array of answer groups.

(Inherited from QuestionWithAnswers.)
 source
public get

The array of answers.

(Inherited from QuestionWithAnswers.)
 source
public get

answerButtons: boolean

Is it answer buttons.

(Inherited from SingleQuestion.)
 source
public get

defaultValue: string

The default answer code applied to a question.

(Inherited from SingleQuestion.)
 source
public get

dropdown: boolean

Is it dropdown.

(Inherited from SingleQuestion.)
 source
public get
(Inherited from SingleQuestion.)
 source
public get

layoutColumns: number

Number of columns for answers placement.

(Inherited from SingleQuestion.)
 source
public get

layoutRows: number

Number of rows for answers placement.

(Inherited from SingleQuestion.)
 source
public get

otherValues: object

{<answerCode>: <otherValue>}

(Inherited from SingleQuestion.)
 source
public get

refusedValue: string

The default answer code applied to a question.

(Inherited from SingleQuestion.)
 source
public get

slider: boolean

Is it slider.

(Inherited from SingleQuestion.)
 source
public get

sliderIsVertical: boolean

Is slider vertical.

(Inherited from SingleQuestion.)
 source
public get

value: string

Selected value.

(Inherited from SingleQuestion.)
 source

Method Summary

Public Methods
public

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

Perform question validation

(Inherited from QuestionBase.)
 source
public

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

Clear question values.

(Inherited from SingleQuestion.)
 source
public

setOtherValue(answerCode: string, otherValue: string)

Set other answer value.

(Inherited from SingleQuestion.)
 source
public

setValue(value: string)

Answer code, optional other value.

(Inherited from SingleQuestion.)
 source

Public Constructors

public constructor(model: object, searchableAnswerListService: SearchableAnswerListService) source

Create instance.

Override:

SingleQuestion#constructor

Params:

NameTypeAttributeDescription
model object

The instance of the model.
searchableAnswerListService SearchableAnswerListService

searchable answer list service.

Public Members

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 answerButtons: boolean source

Is it answer buttons.

public get defaultValue: string source

The default answer code applied to a question. CATI or CAPI interviewer can use the Default button or keyboard shortcut to select the default answer.

public get dropdown: boolean source

Is it dropdown.

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 otherValues: object source

{<answerCode>: <otherValue>}

public get refusedValue: string source

The default answer code applied to a question. CATI or CAPI interviewer can use the Default button or keyboard shortcut to select the default answer.

public get slider: boolean source

Is it slider.

public get sliderIsVertical: boolean source

Is slider vertical.

public get value: string source

Selected value.

Public Methods

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

Perform question validation

Params:

NameTypeAttributeDescription
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:

NameTypeAttributeDescription
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:

NameTypeAttributeDescription
code string

Answer code.

Return:

Answer

public getAnswerGroup(code: string): HeadGroup source

Get answer group by code.

Params:

NameTypeAttributeDescription
code string

Group code.

Return:

HeadGroup

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

Get answers array by codes array.

Params:

NameTypeAttributeDescription
codes string[]

Array of answer codes.

Return:

Answer[]

public clearValues() source

Clear question values.

Override:

Question#clearValues

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

Set other answer value.

Params:

NameTypeAttributeDescription
answerCode string

Answer code.
otherValue string

Other value.

public setValue(value: string) source

Answer code, optional other value.

Params:

NameTypeAttributeDescription
value string

Answer code.