questions package¶
Submodules¶
- questions.cli module
- questions.form module
- questions.questions module
BarRatingQuestion
BarRatingQuestion.choices
BarRatingQuestion.choices_by_url
BarRatingQuestion.choices_enable_if
BarRatingQuestion.choices_max
BarRatingQuestion.choices_min
BarRatingQuestion.choices_order
BarRatingQuestion.choices_step
BarRatingQuestion.choices_visible_if
BarRatingQuestion.col_count
BarRatingQuestion.correct_answer
BarRatingQuestion.default_value
BarRatingQuestion.description
BarRatingQuestion.description_location
BarRatingQuestion.enable_if
BarRatingQuestion.extra_css
BarRatingQuestion.extra_js
BarRatingQuestion.has_other
BarRatingQuestion.hide_if_choices_empty
BarRatingQuestion.hide_number
BarRatingQuestion.indent
BarRatingQuestion.kind
BarRatingQuestion.max_width
BarRatingQuestion.min_width
BarRatingQuestion.name
BarRatingQuestion.options_caption
BarRatingQuestion.other_error_text
BarRatingQuestion.other_place_holder
BarRatingQuestion.other_text
BarRatingQuestion.rating_theme
BarRatingQuestion.required
BarRatingQuestion.required_error_text
BarRatingQuestion.required_if
BarRatingQuestion.show_options_caption
BarRatingQuestion.show_values
BarRatingQuestion.start_with_new_line
BarRatingQuestion.title
BarRatingQuestion.title_location
BarRatingQuestion.use_display_values_in_title
BarRatingQuestion.validators
BarRatingQuestion.value_name
BarRatingQuestion.visible
BarRatingQuestion.visible_if
BarRatingQuestion.width
BooleanQuestion
BooleanQuestion.correct_answer
BooleanQuestion.default_value
BooleanQuestion.description
BooleanQuestion.description_location
BooleanQuestion.enable_if
BooleanQuestion.extra_css
BooleanQuestion.extra_js
BooleanQuestion.hide_number
BooleanQuestion.indent
BooleanQuestion.kind
BooleanQuestion.label_false
BooleanQuestion.label_true
BooleanQuestion.max_width
BooleanQuestion.min_width
BooleanQuestion.name
BooleanQuestion.required
BooleanQuestion.required_error_text
BooleanQuestion.required_if
BooleanQuestion.show_title
BooleanQuestion.start_with_new_line
BooleanQuestion.title
BooleanQuestion.title_location
BooleanQuestion.use_display_values_in_title
BooleanQuestion.validators
BooleanQuestion.value_false
BooleanQuestion.value_name
BooleanQuestion.value_true
BooleanQuestion.visible
BooleanQuestion.visible_if
BooleanQuestion.width
BootstrapDatePickerQuestion
BootstrapDatePickerQuestion.auto_close
BootstrapDatePickerQuestion.auto_unmask
BootstrapDatePickerQuestion.clear_button
BootstrapDatePickerQuestion.correct_answer
BootstrapDatePickerQuestion.date_format
BootstrapDatePickerQuestion.days_of_week_highlighted
BootstrapDatePickerQuestion.default_value
BootstrapDatePickerQuestion.description
BootstrapDatePickerQuestion.description_location
BootstrapDatePickerQuestion.disable_touch_keyboard
BootstrapDatePickerQuestion.enable_if
BootstrapDatePickerQuestion.end_date
BootstrapDatePickerQuestion.extra_css
BootstrapDatePickerQuestion.extra_js
BootstrapDatePickerQuestion.hide_number
BootstrapDatePickerQuestion.indent
BootstrapDatePickerQuestion.input_format
BootstrapDatePickerQuestion.input_mask
BootstrapDatePickerQuestion.input_type
BootstrapDatePickerQuestion.kind
BootstrapDatePickerQuestion.max_length
BootstrapDatePickerQuestion.max_value
BootstrapDatePickerQuestion.max_width
BootstrapDatePickerQuestion.min_value
BootstrapDatePickerQuestion.min_width
BootstrapDatePickerQuestion.name
BootstrapDatePickerQuestion.place_holder
BootstrapDatePickerQuestion.prefix
BootstrapDatePickerQuestion.required
BootstrapDatePickerQuestion.required_error_text
BootstrapDatePickerQuestion.required_if
BootstrapDatePickerQuestion.size
BootstrapDatePickerQuestion.start_date
BootstrapDatePickerQuestion.start_with_new_line
BootstrapDatePickerQuestion.step
BootstrapDatePickerQuestion.text_update_mode
BootstrapDatePickerQuestion.title
BootstrapDatePickerQuestion.title_location
BootstrapDatePickerQuestion.today_highlight
BootstrapDatePickerQuestion.use_display_values_in_title
BootstrapDatePickerQuestion.validators
BootstrapDatePickerQuestion.value_name
BootstrapDatePickerQuestion.visible
BootstrapDatePickerQuestion.visible_if
BootstrapDatePickerQuestion.week_start
BootstrapDatePickerQuestion.width
BootstrapSliderQuestion
BootstrapSliderQuestion.correct_answer
BootstrapSliderQuestion.default_value
BootstrapSliderQuestion.description
BootstrapSliderQuestion.description_location
BootstrapSliderQuestion.enable_if
BootstrapSliderQuestion.extra_css
BootstrapSliderQuestion.extra_js
BootstrapSliderQuestion.hide_number
BootstrapSliderQuestion.indent
BootstrapSliderQuestion.kind
BootstrapSliderQuestion.max_width
BootstrapSliderQuestion.min_width
BootstrapSliderQuestion.name
BootstrapSliderQuestion.range_max
BootstrapSliderQuestion.range_min
BootstrapSliderQuestion.required
BootstrapSliderQuestion.required_error_text
BootstrapSliderQuestion.required_if
BootstrapSliderQuestion.start_with_new_line
BootstrapSliderQuestion.step
BootstrapSliderQuestion.title
BootstrapSliderQuestion.title_location
BootstrapSliderQuestion.use_display_values_in_title
BootstrapSliderQuestion.validators
BootstrapSliderQuestion.value_name
BootstrapSliderQuestion.visible
BootstrapSliderQuestion.visible_if
BootstrapSliderQuestion.width
CKEditorQuestion
CKEditorQuestion.correct_answer
CKEditorQuestion.default_value
CKEditorQuestion.description
CKEditorQuestion.description_location
CKEditorQuestion.enable_if
CKEditorQuestion.extra_css
CKEditorQuestion.extra_js
CKEditorQuestion.height
CKEditorQuestion.hide_number
CKEditorQuestion.indent
CKEditorQuestion.kind
CKEditorQuestion.max_width
CKEditorQuestion.min_width
CKEditorQuestion.name
CKEditorQuestion.required
CKEditorQuestion.required_error_text
CKEditorQuestion.required_if
CKEditorQuestion.start_with_new_line
CKEditorQuestion.title
CKEditorQuestion.title_location
CKEditorQuestion.use_display_values_in_title
CKEditorQuestion.validators
CKEditorQuestion.value_name
CKEditorQuestion.visible
CKEditorQuestion.visible_if
CKEditorQuestion.width
CheckboxQuestion
CheckboxQuestion.choices
CheckboxQuestion.choices_by_url
CheckboxQuestion.choices_enable_if
CheckboxQuestion.choices_order
CheckboxQuestion.choices_visible_if
CheckboxQuestion.col_count
CheckboxQuestion.correct_answer
CheckboxQuestion.default_value
CheckboxQuestion.description
CheckboxQuestion.description_location
CheckboxQuestion.enable_if
CheckboxQuestion.extra_css
CheckboxQuestion.extra_js
CheckboxQuestion.has_none
CheckboxQuestion.has_other
CheckboxQuestion.has_select_all
CheckboxQuestion.hide_if_choices_empty
CheckboxQuestion.hide_number
CheckboxQuestion.indent
CheckboxQuestion.kind
CheckboxQuestion.max_width
CheckboxQuestion.min_width
CheckboxQuestion.name
CheckboxQuestion.none_text
CheckboxQuestion.other_error_text
CheckboxQuestion.other_place_holder
CheckboxQuestion.other_text
CheckboxQuestion.required
CheckboxQuestion.required_error_text
CheckboxQuestion.required_if
CheckboxQuestion.select_all_text
CheckboxQuestion.start_with_new_line
CheckboxQuestion.title
CheckboxQuestion.title_location
CheckboxQuestion.use_display_values_in_title
CheckboxQuestion.validators
CheckboxQuestion.value_name
CheckboxQuestion.visible
CheckboxQuestion.visible_if
CheckboxQuestion.width
ChoicesQuestion
ChoicesQuestion.choices
ChoicesQuestion.choices_by_url
ChoicesQuestion.choices_enable_if
ChoicesQuestion.choices_order
ChoicesQuestion.choices_visible_if
ChoicesQuestion.col_count
ChoicesQuestion.has_other
ChoicesQuestion.hide_if_choices_empty
ChoicesQuestion.kind
ChoicesQuestion.other_error_text
ChoicesQuestion.other_place_holder
ChoicesQuestion.other_text
CommentQuestion
CommentQuestion.cols
CommentQuestion.correct_answer
CommentQuestion.default_value
CommentQuestion.description
CommentQuestion.description_location
CommentQuestion.enable_if
CommentQuestion.extra_css
CommentQuestion.extra_js
CommentQuestion.hide_number
CommentQuestion.indent
CommentQuestion.kind
CommentQuestion.max_length
CommentQuestion.max_width
CommentQuestion.min_width
CommentQuestion.name
CommentQuestion.place_holder
CommentQuestion.required
CommentQuestion.required_error_text
CommentQuestion.required_if
CommentQuestion.rows
CommentQuestion.start_with_new_line
CommentQuestion.text_update_mode
CommentQuestion.title
CommentQuestion.title_location
CommentQuestion.use_display_values_in_title
CommentQuestion.validators
CommentQuestion.value_name
CommentQuestion.visible
CommentQuestion.visible_if
CommentQuestion.width
DropdownQuestion
DropdownQuestion.choices
DropdownQuestion.choices_by_url
DropdownQuestion.choices_enable_if
DropdownQuestion.choices_max
DropdownQuestion.choices_min
DropdownQuestion.choices_order
DropdownQuestion.choices_step
DropdownQuestion.choices_visible_if
DropdownQuestion.col_count
DropdownQuestion.correct_answer
DropdownQuestion.default_value
DropdownQuestion.description
DropdownQuestion.description_location
DropdownQuestion.enable_if
DropdownQuestion.extra_css
DropdownQuestion.extra_js
DropdownQuestion.has_other
DropdownQuestion.hide_if_choices_empty
DropdownQuestion.hide_number
DropdownQuestion.indent
DropdownQuestion.kind
DropdownQuestion.max_width
DropdownQuestion.min_width
DropdownQuestion.name
DropdownQuestion.options_caption
DropdownQuestion.other_error_text
DropdownQuestion.other_place_holder
DropdownQuestion.other_text
DropdownQuestion.required
DropdownQuestion.required_error_text
DropdownQuestion.required_if
DropdownQuestion.show_options_caption
DropdownQuestion.start_with_new_line
DropdownQuestion.title
DropdownQuestion.title_location
DropdownQuestion.use_display_values_in_title
DropdownQuestion.validators
DropdownQuestion.value_name
DropdownQuestion.visible
DropdownQuestion.visible_if
DropdownQuestion.width
EmailValidator
EmotionsRatingQuestion
EmotionsRatingQuestion.bg_emotion
EmotionsRatingQuestion.choices
EmotionsRatingQuestion.choices_by_url
EmotionsRatingQuestion.choices_enable_if
EmotionsRatingQuestion.choices_max
EmotionsRatingQuestion.choices_min
EmotionsRatingQuestion.choices_order
EmotionsRatingQuestion.choices_step
EmotionsRatingQuestion.choices_visible_if
EmotionsRatingQuestion.col_count
EmotionsRatingQuestion.correct_answer
EmotionsRatingQuestion.default_value
EmotionsRatingQuestion.description
EmotionsRatingQuestion.description_location
EmotionsRatingQuestion.emotion_color
EmotionsRatingQuestion.emotion_size
EmotionsRatingQuestion.emotions
EmotionsRatingQuestion.emotions_count
EmotionsRatingQuestion.enable_if
EmotionsRatingQuestion.extra_css
EmotionsRatingQuestion.extra_js
EmotionsRatingQuestion.has_other
EmotionsRatingQuestion.hide_if_choices_empty
EmotionsRatingQuestion.hide_number
EmotionsRatingQuestion.indent
EmotionsRatingQuestion.kind
EmotionsRatingQuestion.max_width
EmotionsRatingQuestion.min_width
EmotionsRatingQuestion.name
EmotionsRatingQuestion.options_caption
EmotionsRatingQuestion.other_error_text
EmotionsRatingQuestion.other_place_holder
EmotionsRatingQuestion.other_text
EmotionsRatingQuestion.required
EmotionsRatingQuestion.required_error_text
EmotionsRatingQuestion.required_if
EmotionsRatingQuestion.show_options_caption
EmotionsRatingQuestion.start_with_new_line
EmotionsRatingQuestion.title
EmotionsRatingQuestion.title_location
EmotionsRatingQuestion.use_display_values_in_title
EmotionsRatingQuestion.validators
EmotionsRatingQuestion.value_name
EmotionsRatingQuestion.visible
EmotionsRatingQuestion.visible_if
EmotionsRatingQuestion.width
ExpressionBlock
ExpressionBlock.correct_answer
ExpressionBlock.currency
ExpressionBlock.default_value
ExpressionBlock.description
ExpressionBlock.description_location
ExpressionBlock.display_style
ExpressionBlock.enable_if
ExpressionBlock.expression
ExpressionBlock.expression_format
ExpressionBlock.extra_css
ExpressionBlock.extra_js
ExpressionBlock.hide_number
ExpressionBlock.indent
ExpressionBlock.kind
ExpressionBlock.max_width
ExpressionBlock.maximum_fraction_digits
ExpressionBlock.min_width
ExpressionBlock.minimum_fraction_digits
ExpressionBlock.name
ExpressionBlock.required
ExpressionBlock.required_error_text
ExpressionBlock.required_if
ExpressionBlock.start_with_new_line
ExpressionBlock.title
ExpressionBlock.title_location
ExpressionBlock.use_display_values_in_title
ExpressionBlock.use_grouping
ExpressionBlock.validators
ExpressionBlock.value_name
ExpressionBlock.visible
ExpressionBlock.visible_if
ExpressionBlock.width
ExpressionValidator
FileQuestion
FileQuestion.accepted_types
FileQuestion.allow_images_preview
FileQuestion.allow_multiple
FileQuestion.correct_answer
FileQuestion.default_value
FileQuestion.description
FileQuestion.description_location
FileQuestion.enable_if
FileQuestion.extra_css
FileQuestion.extra_js
FileQuestion.hide_number
FileQuestion.image_height
FileQuestion.image_width
FileQuestion.indent
FileQuestion.kind
FileQuestion.max_size
FileQuestion.max_width
FileQuestion.min_width
FileQuestion.name
FileQuestion.need_confirm_remove_file
FileQuestion.required
FileQuestion.required_error_text
FileQuestion.required_if
FileQuestion.show_preview
FileQuestion.start_with_new_line
FileQuestion.store_data_as_text
FileQuestion.title
FileQuestion.title_location
FileQuestion.use_display_values_in_title
FileQuestion.validators
FileQuestion.value_name
FileQuestion.visible
FileQuestion.visible_if
FileQuestion.wait_for_upload
FileQuestion.width
HtmlBlock
HtmlBlock.correct_answer
HtmlBlock.default_value
HtmlBlock.description
HtmlBlock.description_location
HtmlBlock.enable_if
HtmlBlock.extra_css
HtmlBlock.extra_js
HtmlBlock.hide_number
HtmlBlock.html
HtmlBlock.indent
HtmlBlock.kind
HtmlBlock.max_width
HtmlBlock.min_width
HtmlBlock.name
HtmlBlock.required
HtmlBlock.required_error_text
HtmlBlock.required_if
HtmlBlock.start_with_new_line
HtmlBlock.title
HtmlBlock.title_location
HtmlBlock.use_display_values_in_title
HtmlBlock.validators
HtmlBlock.value_name
HtmlBlock.visible
HtmlBlock.visible_if
HtmlBlock.width
ImageBlock
ImageBlock.content_mode
ImageBlock.correct_answer
ImageBlock.default_value
ImageBlock.description
ImageBlock.description_location
ImageBlock.enable_if
ImageBlock.extra_css
ImageBlock.extra_js
ImageBlock.hide_number
ImageBlock.image_fit
ImageBlock.image_height
ImageBlock.image_link
ImageBlock.image_width
ImageBlock.indent
ImageBlock.kind
ImageBlock.max_width
ImageBlock.min_width
ImageBlock.name
ImageBlock.required
ImageBlock.required_error_text
ImageBlock.required_if
ImageBlock.start_with_new_line
ImageBlock.title
ImageBlock.title_location
ImageBlock.use_display_values_in_title
ImageBlock.validators
ImageBlock.value_name
ImageBlock.visible
ImageBlock.visible_if
ImageBlock.width
ImagePickerQuestion
ImagePickerQuestion.choices
ImagePickerQuestion.choices_by_url
ImagePickerQuestion.choices_enable_if
ImagePickerQuestion.choices_order
ImagePickerQuestion.choices_visible_if
ImagePickerQuestion.col_count
ImagePickerQuestion.content_mode
ImagePickerQuestion.correct_answer
ImagePickerQuestion.default_value
ImagePickerQuestion.description
ImagePickerQuestion.description_location
ImagePickerQuestion.enable_if
ImagePickerQuestion.extra_css
ImagePickerQuestion.extra_js
ImagePickerQuestion.has_other
ImagePickerQuestion.hide_if_choices_empty
ImagePickerQuestion.hide_number
ImagePickerQuestion.image_fit
ImagePickerQuestion.image_height
ImagePickerQuestion.image_width
ImagePickerQuestion.indent
ImagePickerQuestion.kind
ImagePickerQuestion.max_width
ImagePickerQuestion.min_width
ImagePickerQuestion.multi_select
ImagePickerQuestion.name
ImagePickerQuestion.other_error_text
ImagePickerQuestion.other_place_holder
ImagePickerQuestion.other_text
ImagePickerQuestion.required
ImagePickerQuestion.required_error_text
ImagePickerQuestion.required_if
ImagePickerQuestion.show_label
ImagePickerQuestion.start_with_new_line
ImagePickerQuestion.title
ImagePickerQuestion.title_location
ImagePickerQuestion.use_display_values_in_title
ImagePickerQuestion.validators
ImagePickerQuestion.value_name
ImagePickerQuestion.visible
ImagePickerQuestion.visible_if
ImagePickerQuestion.width
JQueryUIDatePickerQuestion
JQueryUIDatePickerQuestion.auto_unmask
JQueryUIDatePickerQuestion.config
JQueryUIDatePickerQuestion.correct_answer
JQueryUIDatePickerQuestion.date_format
JQueryUIDatePickerQuestion.default_value
JQueryUIDatePickerQuestion.description
JQueryUIDatePickerQuestion.description_location
JQueryUIDatePickerQuestion.enable_if
JQueryUIDatePickerQuestion.extra_css
JQueryUIDatePickerQuestion.extra_js
JQueryUIDatePickerQuestion.hide_number
JQueryUIDatePickerQuestion.indent
JQueryUIDatePickerQuestion.input_format
JQueryUIDatePickerQuestion.input_mask
JQueryUIDatePickerQuestion.input_type
JQueryUIDatePickerQuestion.kind
JQueryUIDatePickerQuestion.max_date
JQueryUIDatePickerQuestion.max_length
JQueryUIDatePickerQuestion.max_value
JQueryUIDatePickerQuestion.max_width
JQueryUIDatePickerQuestion.min_date
JQueryUIDatePickerQuestion.min_value
JQueryUIDatePickerQuestion.min_width
JQueryUIDatePickerQuestion.name
JQueryUIDatePickerQuestion.place_holder
JQueryUIDatePickerQuestion.prefix
JQueryUIDatePickerQuestion.required
JQueryUIDatePickerQuestion.required_error_text
JQueryUIDatePickerQuestion.required_if
JQueryUIDatePickerQuestion.size
JQueryUIDatePickerQuestion.start_with_new_line
JQueryUIDatePickerQuestion.step
JQueryUIDatePickerQuestion.text_update_mode
JQueryUIDatePickerQuestion.title
JQueryUIDatePickerQuestion.title_location
JQueryUIDatePickerQuestion.use_display_values_in_title
JQueryUIDatePickerQuestion.validators
JQueryUIDatePickerQuestion.value_name
JQueryUIDatePickerQuestion.visible
JQueryUIDatePickerQuestion.visible_if
JQueryUIDatePickerQuestion.width
MatrixDropdownQuestion
MatrixDropdownQuestion.all_rows_required
MatrixDropdownQuestion.cell_type
MatrixDropdownQuestion.cells
MatrixDropdownQuestion.choices
MatrixDropdownQuestion.column_col_count
MatrixDropdownQuestion.column_layout
MatrixDropdownQuestion.column_min_width
MatrixDropdownQuestion.columns
MatrixDropdownQuestion.columns_visible_if
MatrixDropdownQuestion.correct_answer
MatrixDropdownQuestion.default_value
MatrixDropdownQuestion.description
MatrixDropdownQuestion.description_location
MatrixDropdownQuestion.enable_if
MatrixDropdownQuestion.extra_css
MatrixDropdownQuestion.extra_js
MatrixDropdownQuestion.hide_number
MatrixDropdownQuestion.horizontal_scroll
MatrixDropdownQuestion.indent
MatrixDropdownQuestion.kind
MatrixDropdownQuestion.max_width
MatrixDropdownQuestion.min_width
MatrixDropdownQuestion.name
MatrixDropdownQuestion.options_caption
MatrixDropdownQuestion.required
MatrixDropdownQuestion.required_error_text
MatrixDropdownQuestion.required_if
MatrixDropdownQuestion.row_title_width
MatrixDropdownQuestion.rows
MatrixDropdownQuestion.rows_order
MatrixDropdownQuestion.rows_visible_if
MatrixDropdownQuestion.show_header
MatrixDropdownQuestion.start_with_new_line
MatrixDropdownQuestion.title
MatrixDropdownQuestion.title_location
MatrixDropdownQuestion.total_text
MatrixDropdownQuestion.use_display_values_in_title
MatrixDropdownQuestion.validators
MatrixDropdownQuestion.value_name
MatrixDropdownQuestion.visible
MatrixDropdownQuestion.visible_if
MatrixDropdownQuestion.width
MatrixDynamicQuestion
MatrixDynamicQuestion.add_row_location
MatrixDynamicQuestion.add_row_text
MatrixDynamicQuestion.all_rows_required
MatrixDynamicQuestion.allow_add_rows
MatrixDynamicQuestion.allow_remove_rows
MatrixDynamicQuestion.cell_type
MatrixDynamicQuestion.cells
MatrixDynamicQuestion.choices
MatrixDynamicQuestion.column_col_count
MatrixDynamicQuestion.column_layout
MatrixDynamicQuestion.column_min_width
MatrixDynamicQuestion.columns
MatrixDynamicQuestion.columns_visible_if
MatrixDynamicQuestion.confirm_delete
MatrixDynamicQuestion.confirm_delete_text
MatrixDynamicQuestion.correct_answer
MatrixDynamicQuestion.default_row_value
MatrixDynamicQuestion.default_value
MatrixDynamicQuestion.default_value_from_last_row
MatrixDynamicQuestion.description
MatrixDynamicQuestion.description_location
MatrixDynamicQuestion.enable_if
MatrixDynamicQuestion.extra_css
MatrixDynamicQuestion.extra_js
MatrixDynamicQuestion.hide_number
MatrixDynamicQuestion.horizontal_scroll
MatrixDynamicQuestion.indent
MatrixDynamicQuestion.key_duplication_error
MatrixDynamicQuestion.key_name
MatrixDynamicQuestion.kind
MatrixDynamicQuestion.max_row_count
MatrixDynamicQuestion.max_width
MatrixDynamicQuestion.min_row_count
MatrixDynamicQuestion.min_width
MatrixDynamicQuestion.name
MatrixDynamicQuestion.options_caption
MatrixDynamicQuestion.remove_row_text
MatrixDynamicQuestion.required
MatrixDynamicQuestion.required_error_text
MatrixDynamicQuestion.required_if
MatrixDynamicQuestion.row_count
MatrixDynamicQuestion.rows
MatrixDynamicQuestion.rows_order
MatrixDynamicQuestion.rows_visible_if
MatrixDynamicQuestion.show_header
MatrixDynamicQuestion.start_with_new_line
MatrixDynamicQuestion.title
MatrixDynamicQuestion.title_location
MatrixDynamicQuestion.use_display_values_in_title
MatrixDynamicQuestion.validators
MatrixDynamicQuestion.value_name
MatrixDynamicQuestion.visible
MatrixDynamicQuestion.visible_if
MatrixDynamicQuestion.width
MatrixQuestion
MatrixQuestion.all_rows_required
MatrixQuestion.cells
MatrixQuestion.columns
MatrixQuestion.columns_visible_if
MatrixQuestion.correct_answer
MatrixQuestion.default_value
MatrixQuestion.description
MatrixQuestion.description_location
MatrixQuestion.enable_if
MatrixQuestion.extra_css
MatrixQuestion.extra_js
MatrixQuestion.hide_number
MatrixQuestion.indent
MatrixQuestion.kind
MatrixQuestion.max_width
MatrixQuestion.min_width
MatrixQuestion.name
MatrixQuestion.required
MatrixQuestion.required_error_text
MatrixQuestion.required_if
MatrixQuestion.rows
MatrixQuestion.rows_order
MatrixQuestion.rows_visible_if
MatrixQuestion.show_header
MatrixQuestion.start_with_new_line
MatrixQuestion.title
MatrixQuestion.title_location
MatrixQuestion.use_display_values_in_title
MatrixQuestion.validators
MatrixQuestion.value_name
MatrixQuestion.visible
MatrixQuestion.visible_if
MatrixQuestion.width
MicrophoneQuestion
MicrophoneQuestion.correct_answer
MicrophoneQuestion.default_value
MicrophoneQuestion.description
MicrophoneQuestion.description_location
MicrophoneQuestion.enable_if
MicrophoneQuestion.extra_css
MicrophoneQuestion.extra_js
MicrophoneQuestion.hide_number
MicrophoneQuestion.indent
MicrophoneQuestion.kind
MicrophoneQuestion.max_width
MicrophoneQuestion.min_width
MicrophoneQuestion.name
MicrophoneQuestion.required
MicrophoneQuestion.required_error_text
MicrophoneQuestion.required_if
MicrophoneQuestion.start_with_new_line
MicrophoneQuestion.title
MicrophoneQuestion.title_location
MicrophoneQuestion.use_display_values_in_title
MicrophoneQuestion.validators
MicrophoneQuestion.value_name
MicrophoneQuestion.visible
MicrophoneQuestion.visible_if
MicrophoneQuestion.width
MultipleTextQuestion
MultipleTextQuestion.col_count
MultipleTextQuestion.correct_answer
MultipleTextQuestion.default_value
MultipleTextQuestion.description
MultipleTextQuestion.description_location
MultipleTextQuestion.enable_if
MultipleTextQuestion.extra_css
MultipleTextQuestion.extra_js
MultipleTextQuestion.hide_number
MultipleTextQuestion.indent
MultipleTextQuestion.item_size
MultipleTextQuestion.items
MultipleTextQuestion.kind
MultipleTextQuestion.max_width
MultipleTextQuestion.min_width
MultipleTextQuestion.name
MultipleTextQuestion.required
MultipleTextQuestion.required_error_text
MultipleTextQuestion.required_if
MultipleTextQuestion.start_with_new_line
MultipleTextQuestion.title
MultipleTextQuestion.title_location
MultipleTextQuestion.use_display_values_in_title
MultipleTextQuestion.validators
MultipleTextQuestion.value_name
MultipleTextQuestion.visible
MultipleTextQuestion.visible_if
MultipleTextQuestion.width
NoUISliderQuestion
NoUISliderQuestion.correct_answer
NoUISliderQuestion.default_value
NoUISliderQuestion.description
NoUISliderQuestion.description_location
NoUISliderQuestion.direction
NoUISliderQuestion.enable_if
NoUISliderQuestion.extra_css
NoUISliderQuestion.extra_js
NoUISliderQuestion.hide_number
NoUISliderQuestion.indent
NoUISliderQuestion.kind
NoUISliderQuestion.max_width
NoUISliderQuestion.min_width
NoUISliderQuestion.name
NoUISliderQuestion.orientation
NoUISliderQuestion.pips_density
NoUISliderQuestion.pips_mode
NoUISliderQuestion.pips_text
NoUISliderQuestion.pips_values
NoUISliderQuestion.range_max
NoUISliderQuestion.range_min
NoUISliderQuestion.required
NoUISliderQuestion.required_error_text
NoUISliderQuestion.required_if
NoUISliderQuestion.start_with_new_line
NoUISliderQuestion.step
NoUISliderQuestion.title
NoUISliderQuestion.title_location
NoUISliderQuestion.tooltips
NoUISliderQuestion.use_display_values_in_title
NoUISliderQuestion.validators
NoUISliderQuestion.value_name
NoUISliderQuestion.visible
NoUISliderQuestion.visible_if
NoUISliderQuestion.width
NumericValidator
Page
PanelBlock
PanelDynamicBlock
PanelDynamicBlock.allow_add_panel
PanelDynamicBlock.allow_remove_panel
PanelDynamicBlock.confirm_delete
PanelDynamicBlock.confirm_delete_text
PanelDynamicBlock.default_value_from_last_panel
PanelDynamicBlock.inner_indent
PanelDynamicBlock.key_duplication_error
PanelDynamicBlock.key_name
PanelDynamicBlock.kind
PanelDynamicBlock.max_panel_count
PanelDynamicBlock.min_panel_count
PanelDynamicBlock.panel_add_text
PanelDynamicBlock.panel_count
PanelDynamicBlock.panel_next_text
PanelDynamicBlock.panel_prev_text
PanelDynamicBlock.panel_remove_text
PanelDynamicBlock.panels_state
PanelDynamicBlock.render_mode
PanelDynamicBlock.show_question_numbers
PanelDynamicBlock.show_range_in_progress
PanelDynamicBlock.template_description
PanelDynamicBlock.template_elements
PanelDynamicBlock.template_title
PanelDynamicBlock.template_title_location
Question
Question.correct_answer
Question.default_value
Question.description
Question.description_location
Question.enable_if
Question.extra_css
Question.extra_js
Question.hide_number
Question.indent
Question.kind
Question.max_width
Question.min_width
Question.name
Question.required
Question.required_error_text
Question.required_if
Question.start_with_new_line
Question.title
Question.title_location
Question.use_display_values_in_title
Question.validators
Question.value_name
Question.visible
Question.visible_if
Question.width
RadioGroupQuestion
RadioGroupQuestion.choices
RadioGroupQuestion.choices_by_url
RadioGroupQuestion.choices_enable_if
RadioGroupQuestion.choices_order
RadioGroupQuestion.choices_visible_if
RadioGroupQuestion.col_count
RadioGroupQuestion.correct_answer
RadioGroupQuestion.default_value
RadioGroupQuestion.description
RadioGroupQuestion.description_location
RadioGroupQuestion.enable_if
RadioGroupQuestion.extra_css
RadioGroupQuestion.extra_js
RadioGroupQuestion.has_other
RadioGroupQuestion.hide_if_choices_empty
RadioGroupQuestion.hide_number
RadioGroupQuestion.indent
RadioGroupQuestion.kind
RadioGroupQuestion.max_width
RadioGroupQuestion.min_width
RadioGroupQuestion.name
RadioGroupQuestion.other_error_text
RadioGroupQuestion.other_place_holder
RadioGroupQuestion.other_text
RadioGroupQuestion.required
RadioGroupQuestion.required_error_text
RadioGroupQuestion.required_if
RadioGroupQuestion.show_clear_button
RadioGroupQuestion.start_with_new_line
RadioGroupQuestion.title
RadioGroupQuestion.title_location
RadioGroupQuestion.use_display_values_in_title
RadioGroupQuestion.validators
RadioGroupQuestion.value_name
RadioGroupQuestion.visible
RadioGroupQuestion.visible_if
RadioGroupQuestion.width
RatingQuestion
RatingQuestion.correct_answer
RatingQuestion.default_value
RatingQuestion.description
RatingQuestion.description_location
RatingQuestion.enable_if
RatingQuestion.extra_css
RatingQuestion.extra_js
RatingQuestion.hide_number
RatingQuestion.indent
RatingQuestion.kind
RatingQuestion.max_rate_description
RatingQuestion.max_width
RatingQuestion.min_rate_description
RatingQuestion.min_width
RatingQuestion.name
RatingQuestion.rate_max
RatingQuestion.rate_min
RatingQuestion.rate_step
RatingQuestion.rate_values
RatingQuestion.required
RatingQuestion.required_error_text
RatingQuestion.required_if
RatingQuestion.start_with_new_line
RatingQuestion.title
RatingQuestion.title_location
RatingQuestion.use_display_values_in_title
RatingQuestion.validators
RatingQuestion.value_name
RatingQuestion.visible
RatingQuestion.visible_if
RatingQuestion.width
RegexValidator
Select2Question
Select2Question.choices
Select2Question.choices_by_url
Select2Question.choices_enable_if
Select2Question.choices_max
Select2Question.choices_min
Select2Question.choices_order
Select2Question.choices_step
Select2Question.choices_visible_if
Select2Question.col_count
Select2Question.correct_answer
Select2Question.default_value
Select2Question.description
Select2Question.description_location
Select2Question.enable_if
Select2Question.extra_css
Select2Question.extra_js
Select2Question.has_other
Select2Question.hide_if_choices_empty
Select2Question.hide_number
Select2Question.indent
Select2Question.kind
Select2Question.max_width
Select2Question.min_width
Select2Question.name
Select2Question.options_caption
Select2Question.other_error_text
Select2Question.other_place_holder
Select2Question.other_text
Select2Question.render_as
Select2Question.required
Select2Question.required_error_text
Select2Question.required_if
Select2Question.select2_config
Select2Question.show_options_caption
Select2Question.start_with_new_line
Select2Question.title
Select2Question.title_location
Select2Question.use_display_values_in_title
Select2Question.validators
Select2Question.value_name
Select2Question.visible
Select2Question.visible_if
Select2Question.width
SignaturePadQuestion
SignaturePadQuestion.allow_clear
SignaturePadQuestion.correct_answer
SignaturePadQuestion.default_value
SignaturePadQuestion.description
SignaturePadQuestion.description_location
SignaturePadQuestion.enable_if
SignaturePadQuestion.extra_css
SignaturePadQuestion.extra_js
SignaturePadQuestion.height
SignaturePadQuestion.hide_number
SignaturePadQuestion.indent
SignaturePadQuestion.kind
SignaturePadQuestion.max_width
SignaturePadQuestion.min_width
SignaturePadQuestion.name
SignaturePadQuestion.required
SignaturePadQuestion.required_error_text
SignaturePadQuestion.required_if
SignaturePadQuestion.start_with_new_line
SignaturePadQuestion.title
SignaturePadQuestion.title_location
SignaturePadQuestion.use_display_values_in_title
SignaturePadQuestion.validators
SignaturePadQuestion.value_name
SignaturePadQuestion.visible
SignaturePadQuestion.visible_if
SignaturePadQuestion.width
SortableJSQuestion
SortableJSQuestion.choices
SortableJSQuestion.choices_by_url
SortableJSQuestion.choices_enable_if
SortableJSQuestion.choices_order
SortableJSQuestion.choices_visible_if
SortableJSQuestion.col_count
SortableJSQuestion.correct_answer
SortableJSQuestion.default_value
SortableJSQuestion.description
SortableJSQuestion.description_location
SortableJSQuestion.empty_text
SortableJSQuestion.enable_if
SortableJSQuestion.extra_css
SortableJSQuestion.extra_js
SortableJSQuestion.has_none
SortableJSQuestion.has_other
SortableJSQuestion.has_select_all
SortableJSQuestion.hide_if_choices_empty
SortableJSQuestion.hide_number
SortableJSQuestion.indent
SortableJSQuestion.kind
SortableJSQuestion.max_answers_count
SortableJSQuestion.max_width
SortableJSQuestion.min_width
SortableJSQuestion.name
SortableJSQuestion.none_text
SortableJSQuestion.other_error_text
SortableJSQuestion.other_place_holder
SortableJSQuestion.other_text
SortableJSQuestion.required
SortableJSQuestion.required_error_text
SortableJSQuestion.required_if
SortableJSQuestion.select_all_text
SortableJSQuestion.start_with_new_line
SortableJSQuestion.title
SortableJSQuestion.title_location
SortableJSQuestion.use_display_values_in_title
SortableJSQuestion.validators
SortableJSQuestion.value_name
SortableJSQuestion.visible
SortableJSQuestion.visible_if
SortableJSQuestion.width
Survey
Survey.calculated_values
Survey.check_errors_mode
Survey.clear_invisible_values
Survey.complete_text
Survey.completed_before_html
Survey.completed_html
Survey.completed_html_on_condition
Survey.cookie_name
Survey.description
Survey.edit_text
Survey.first_page_is_started
Survey.focus_first_question_automatic
Survey.focus_on_first_error
Survey.go_next_page_automatic
Survey.loading_html
Survey.locale
Survey.logo
Survey.logo_fit
Survey.logo_height
Survey.logo_position
Survey.logo_width
Survey.max_others_length
Survey.max_text_length
Survey.max_time_to_finish
Survey.mode
Survey.navigate_to_url
Survey.navigate_to_url_on_condition
Survey.page_next_text
Survey.page_prev_text
Survey.pages
Survey.preview_text
Survey.progress_bar_type
Survey.question_description_location
Survey.question_error_location
Survey.question_start_index
Survey.question_title_location
Survey.question_title_pattern
Survey.question_title_template
Survey.questions_on_page_mode
Survey.questions_order
Survey.required_text
Survey.send_result_on_page_next
Survey.show_completed_page
Survey.show_navigation_buttons
Survey.show_page_numbers
Survey.show_page_titles
Survey.show_prev_button
Survey.show_preview_before_complete
Survey.show_progress_bar
Survey.show_question_numbers
Survey.show_timer_panel
Survey.show_timer_panel_mode
Survey.show_title
Survey.start_survey_text
Survey.store_others_as_comment
Survey.survey_id
Survey.survey_post_id
Survey.survey_show_data_saving
Survey.text_update_mode
Survey.title
Survey.triggers
TagBoxQuestion
TagBoxQuestion.choices
TagBoxQuestion.choices_by_url
TagBoxQuestion.choices_enable_if
TagBoxQuestion.choices_max
TagBoxQuestion.choices_min
TagBoxQuestion.choices_order
TagBoxQuestion.choices_step
TagBoxQuestion.choices_visible_if
TagBoxQuestion.col_count
TagBoxQuestion.correct_answer
TagBoxQuestion.default_value
TagBoxQuestion.description
TagBoxQuestion.description_location
TagBoxQuestion.enable_if
TagBoxQuestion.extra_css
TagBoxQuestion.extra_js
TagBoxQuestion.has_other
TagBoxQuestion.hide_if_choices_empty
TagBoxQuestion.hide_number
TagBoxQuestion.indent
TagBoxQuestion.kind
TagBoxQuestion.max_width
TagBoxQuestion.min_width
TagBoxQuestion.name
TagBoxQuestion.options_caption
TagBoxQuestion.other_error_text
TagBoxQuestion.other_place_holder
TagBoxQuestion.other_text
TagBoxQuestion.required
TagBoxQuestion.required_error_text
TagBoxQuestion.required_if
TagBoxQuestion.select2_config
TagBoxQuestion.show_options_caption
TagBoxQuestion.start_with_new_line
TagBoxQuestion.title
TagBoxQuestion.title_location
TagBoxQuestion.use_display_values_in_title
TagBoxQuestion.validators
TagBoxQuestion.value_name
TagBoxQuestion.visible
TagBoxQuestion.visible_if
TagBoxQuestion.width
TextQuestion
TextQuestion.auto_unmask
TextQuestion.correct_answer
TextQuestion.default_value
TextQuestion.description
TextQuestion.description_location
TextQuestion.enable_if
TextQuestion.extra_css
TextQuestion.extra_js
TextQuestion.hide_number
TextQuestion.indent
TextQuestion.input_format
TextQuestion.input_mask
TextQuestion.input_type
TextQuestion.kind
TextQuestion.max_length
TextQuestion.max_value
TextQuestion.max_width
TextQuestion.min_value
TextQuestion.min_width
TextQuestion.name
TextQuestion.place_holder
TextQuestion.prefix
TextQuestion.required
TextQuestion.required_error_text
TextQuestion.required_if
TextQuestion.size
TextQuestion.start_with_new_line
TextQuestion.step
TextQuestion.text_update_mode
TextQuestion.title
TextQuestion.title_location
TextQuestion.use_display_values_in_title
TextQuestion.validators
TextQuestion.value_name
TextQuestion.visible
TextQuestion.visible_if
TextQuestion.width
TextValidator
Validator
- questions.settings module
- questions.templates module
- questions.utils module
- questions.validators module
Module contents¶
Top-level package for Questions.
- class questions.BarRatingQuestion(**data)[source]¶
Bases:
DropdownQuestion
A question that uses the JQuery bar rating widget.
-
extra_css:
List
[HttpUrl
]¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
rating_theme:
Literal
['fontawesome-stars'
,'css-stars'
,'bars-pill'
,'bars-1to10'
,'bars-movie'
,'bars-reversed'
,'bars-horizontal'
,'fontawesome-stars-o'
]¶
-
show_values:
bool
¶
-
extra_css:
- class questions.BooleanQuestion(**data)[source]¶
Bases:
Question
Get the answer for any two-possibility question. Usually true/false, yes/ no questions.
-
kind:
str
¶
-
label_false:
Union
[str
,Dict
[str
,str
]]¶
-
label_true:
Union
[str
,Dict
[str
,str
]]¶
-
show_title:
bool
¶
-
value_false:
Union
[str
,Dict
[str
,str
]]¶
-
value_true:
Union
[str
,Dict
[str
,str
]]¶
-
kind:
- class questions.BootstrapDatePickerQuestion(**data)[source]¶
Bases:
TextQuestion
A question that uses the bootstrap date picker.
-
auto_close:
bool
¶
-
clear_button:
bool
¶
-
date_format:
str
¶
-
days_of_week_highlighted:
str
¶
-
disable_touch_keyboard:
bool
¶
-
end_date:
str
¶
-
extra_css:
List
[HttpUrl
]¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
start_date:
str
¶
-
today_highlight:
bool
¶
-
week_start:
int
¶
-
auto_close:
- class questions.BootstrapSliderQuestion(**data)[source]¶
Bases:
Question
A question that uses the bootstrap slider widget.
-
extra_css:
List
[HttpUrl
]¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
range_max:
int
¶
-
range_min:
int
¶
-
step:
int
¶
-
extra_css:
- class questions.CKEditorQuestion(**data)[source]¶
Bases:
Question
A question that uses the CKEditor JQuery widget.
-
extra_js:
List
[HttpUrl
]¶
-
height:
str
¶
-
kind:
str
¶
-
extra_js:
- class questions.CheckboxQuestion(**data)[source]¶
Bases:
ChoicesQuestion
Select one or more options from a group of check boxes.
-
has_none:
bool
¶
-
has_select_all:
bool
¶
-
kind:
str
¶
-
none_text:
Union
[str
,Dict
[str
,str
]]¶
-
select_all_text:
Union
[str
,Dict
[str
,str
]]¶
-
has_none:
- class questions.CommentQuestion(**data)[source]¶
Bases:
Question
A question that uses a text area to get a multi-line text answer.
-
cols:
int
¶
-
kind:
str
¶
-
max_length:
int
¶
-
place_holder:
Union
[str
,Dict
[str
,str
]]¶
-
rows:
int
¶
-
text_update_mode:
Literal
['default'
,'onBlur'
,'onTyping'
]¶
-
cols:
- class questions.DropdownQuestion(**data)[source]¶
Bases:
ChoicesQuestion
Select one option from a dropdown menu.
-
choices_max:
int
¶
-
choices_min:
int
¶
-
choices_step:
int
¶
-
kind:
str
¶
-
choices_max:
- class questions.EmailValidator(**data)[source]¶
Bases:
Validator
Checks if a value is a valid email address.
-
kind:
str
¶
-
kind:
- class questions.EmotionsRatingQuestion(**data)[source]¶
Bases:
DropdownQuestion
A question that uses the emotion ratings JQuery widget.
-
bg_emotion:
str
¶
-
emotion_color:
str
¶
-
emotion_size:
int
¶
-
emotions:
List
[str
]¶
-
emotions_count:
int
¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
bg_emotion:
- class questions.ExpressionBlock(**data)[source]¶
Bases:
Question
A block that inserts the result of an expression in a form.
-
currency:
str
¶
-
display_style:
Literal
['none'
,'decimal'
,'currency'
,'percent'
,'date'
]¶
-
expression:
str
¶
-
expression_format:
str
¶
-
kind:
str
¶
-
maximum_fraction_digits:
int
¶
-
minimum_fraction_digits:
int
¶
-
use_grouping:
bool
¶
-
currency:
- class questions.ExpressionValidator(**data)[source]¶
Bases:
Validator
Checks if a question’s answer matches a set of conditions.
-
expression:
str
¶
-
kind:
str
¶
-
expression:
- class questions.FileQuestion(**data)[source]¶
Bases:
Question
A question for uploading one or more files.
-
accepted_types:
str
¶
-
allow_images_preview:
bool
¶
-
allow_multiple:
bool
¶
-
image_height:
int
¶
-
image_width:
int
¶
-
kind:
str
¶
-
max_size:
int
¶
-
need_confirm_remove_file:
bool
¶
-
show_preview:
bool
¶
-
store_data_as_text:
bool
¶
-
wait_for_upload:
bool
¶
-
accepted_types:
- class questions.Form(name='', action='', html_id='questions_form', theme='defaultV2', platform='jquery', resource_url=None, **params)[source]¶
Bases:
object
This is the base class used for creating user-defined forms. In addition to setting up the form configuration and performing validation, it generates the SurveyJS form JSON and keeps track of the required Javascript and CSS resources.
- Parameters:
name (
str
) – The name of the form. If empty, the class name is used.action (
str
) – The URL where the form data will be posted. If empty, the same URL for the form is used.html_id (
str
) – The id for the div element that will be used to render the form.theme (
Literal
['defaultV2'
,'bootstrap'
,'modern'
]) – The name of the base theme for the form. Default value is ‘defaultV2’.platform (
Literal
['angular'
,'jquery'
,'knockout'
,'react'
,'vue'
]) – The JS platform to use for generating the form. Default value is ‘jquery’.resource_url (
Optional
[str
]) – The base URL for the theme resources. If provided, Questions will expect to find all resources under this URL. If empty, the SurveyJS CDN will be used for all resources.params – Optional list of parameters to be passed to the SurveyJS form object.
- property css¶
Combined CSS resources for this form.
- default_params = {}¶
- property extra_css¶
Any extra CSS resources required by the form’s question types.
- property extra_js¶
Any extra JS resources required by the form’s question types.
- classmethod from_json(form_json, name)[source]¶
Generate a Form class definition from properly formatted JSON data. The The generated form class can then be instantiated as needed.
- Parameters:
form_json (
str
) – A well formed JSON string with a SurveyJS definition.name (
str
) – The name of the generated class.
- Returns:
A new Python Type that is a subclass of Form.
- property js¶
Combined JS resources for this form.
- questions_resource_url = 'https://unpkg.com'¶
- render_html(title=None, form_data=None)[source]¶
Render a full HTML page showing this form.
- Parameters:
title (
Optional
[str
]) – The form title.form_data (
Optional
[Dict
[str
,Any
]]) – answers to show on the form for each question (for edit forms).
- Returns:
String with the generated HTML.
- render_js(form_data=None)[source]¶
Generate the SurveyJS initialization code for the chosen platform.
- Parameters:
form_data (
Optional
[Dict
[str
,Any
]]) – answers to show on the form for each question (for edit forms).- Returns:
String with the generated javascript.
- property required_css¶
Required CSS resources needed to run SurveyJS on chosen platform.
- property required_js¶
Required JS resources needed to run SurveyJS on chosen platform.
- to_json()[source]¶
Convert the form to JSON, in the SurveyJS format.
- Returns:
JSON object with the form definition.
- update_object(obj, form_data)[source]¶
Utility method to set an object’s attributes with data obtained from a form. This method validates the data before setting the object’s attributes.
- Parameters:
obj (
Any
) – The object to set attributes on.form_data (
Dict
[str
,Any
]) – A dictionary-like object with the form data to be validated.
- Raises:
questions.validators.ValidationError if validation does not pass.
- validate(form_data, set_errors=False)[source]¶
Server side validation mimics what client side validation should do. This means that any validation errors here are due to form data being sent from outside the SurveyJS form, possibly by directly posting the data to the form. Questions keeps track of the errors, even though the UI will show them anyway. Validation returns False if at least one validator doesn’t pass.
- Parameters:
form_data (
Dict
[str
,Any
]) – A dictionary-like object with the form data to be validated.set_errors (
bool
) – set toTrue
to add an __errors__ key to the form data dictionary, containing the validation errors.
- Returns:
True
if the validation passes,False
otherwise.
- class questions.FormPage(form, name='', **params)[source]¶
Bases:
object
Represents an individual page from a multi-page form.
- Parameters:
form (
Type
[Form
]) – A subclass of questions.Form (not an instance). The form to be shown in its own page.name (
str
) – The name of the form.params – Optional list of parameters to be passed to the SurveyJS page object.
- class questions.FormPanel(form, name='', dynamic=False, **params)[source]¶
Bases:
object
A panel is a set of fields that go together. It can be used for visual separation, or as a dynamically added group of fields for complex questions.
- Parameters:
form (
Type
[Form
]) – A subclass of questions.Form (not an instance). The form to be shown in its own page.name (
str
) – The name of the form.dynamic (
bool
) –- Set to
True
if the panel will be used as a template for adding or removing groups of questions.
- Set to
params – Optional list of parameters to be passed to the SurveyJS panel object.
- class questions.HtmlBlock(**data)[source]¶
Bases:
Question
An HTML block that can be embedded in a form.
-
html:
Union
[str
,Dict
[str
,str
]]¶
-
kind:
str
¶
-
html:
- class questions.ImageBlock(**data)[source]¶
Bases:
Question
An block for inserting an image in a form.
-
content_mode:
Literal
['image'
,'video'
]¶
-
image_fit:
Literal
['contain'
,'none'
,'cover'
,'fill'
]¶
-
image_height:
int
¶
-
image_link:
HttpUrl
¶
-
image_width:
int
¶
-
kind:
str
¶
-
content_mode:
- class questions.ImagePickerQuestion(**data)[source]¶
Bases:
ChoicesQuestion
Display a group of images and let the user pick one or more.
-
content_mode:
Literal
['image'
,'video'
]¶
-
has_other:
bool
¶
-
image_fit:
Literal
['contain'
,'none'
,'cover'
,'fill'
]¶
-
image_height:
int
¶
-
image_width:
int
¶
-
kind:
str
¶
-
multi_select:
bool
¶
-
other_error_text:
Union
[str
,Dict
[str
,str
]]¶
-
other_place_holder:
Union
[str
,Dict
[str
,str
]]¶
-
other_text:
Union
[str
,Dict
[str
,str
]]¶
-
show_label:
bool
¶
-
content_mode:
- class questions.JQueryUIDatePickerQuestion(**data)[source]¶
Bases:
TextQuestion
A question that uses the JQueryUI date picker.
-
config:
str
¶
-
date_format:
str
¶
-
extra_css:
List
[HttpUrl
]¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
max_date:
str
¶
-
min_date:
str
¶
-
config:
- class questions.MatrixDropdownQuestion(**data)[source]¶
Bases:
Question
A matrix question that can include other types of input controls, like dropdowns and text boxes.
-
all_rows_required:
bool
¶
-
cell_type:
Literal
['dropdown'
,'checkbox'
,'radiogroup'
,'text'
,'comment'
,'boolean'
,'expression'
,'rating'
]¶
-
cells:
Dict
[str
,Dict
[str
,Any
]]¶
-
choices:
List
[Any
]¶
-
column_col_count:
int
¶
-
column_layout:
Literal
['horizontal'
,'vertical'
]¶
-
column_min_width:
str
¶
-
columns:
List
[Any
]¶
-
columns_visible_if:
str
¶
-
horizontal_scroll:
bool
¶
-
kind:
str
¶
-
row_title_width:
str
¶
-
rows:
List
[Any
]¶
-
rows_order:
Literal
['initial'
,'random'
]¶
-
rows_visible_if:
str
¶
-
show_header:
bool
¶
-
total_text:
str
¶
-
all_rows_required:
- class questions.MatrixDynamicQuestion(**data)[source]¶
Bases:
Question
A matrix dropdown question that allows the user to add or remove new rows from their answer.
-
add_row_location:
Literal
['default'
,'top'
,'bottom'
,'topBottom'
]¶
-
add_row_text:
str
¶
-
all_rows_required:
bool
¶
-
allow_add_rows:
bool
¶
-
allow_remove_rows:
bool
¶
-
cell_type:
Literal
['dropdown'
,'checkbox'
,'radiogroup'
,'text'
,'comment'
,'boolean'
,'expression'
,'rating'
]¶
-
cells:
Dict
[str
,Dict
[str
,Any
]]¶
-
choices:
List
[Any
]¶
-
column_col_count:
int
¶
-
column_layout:
Literal
['horizontal'
,'vertical'
]¶
-
column_min_width:
str
¶
-
columns:
List
[Any
]¶
-
columns_visible_if:
str
¶
-
confirm_delete:
bool
¶
-
confirm_delete_text:
str
¶
-
default_row_value:
Any
¶
-
default_value_from_last_row:
bool
¶
-
horizontal_scroll:
bool
¶
-
key_duplication_error:
str
¶
-
key_name:
str
¶
-
kind:
str
¶
-
max_row_count:
int
¶
-
min_row_count:
int
¶
-
remove_row_text:
str
¶
-
row_count:
int
¶
-
rows:
List
[Any
]¶
-
rows_order:
Literal
['initial'
,'random'
]¶
-
rows_visible_if:
str
¶
-
show_header:
bool
¶
-
add_row_location:
- class questions.MatrixQuestion(**data)[source]¶
Bases:
Question
A question that displays rows of radio buttons and allows the user to select a value from one of several columns for each row.
-
all_rows_required:
bool
¶
-
cells:
Dict
[str
,Dict
[str
,str
]]¶
-
columns:
List
[Any
]¶
-
columns_visible_if:
str
¶
-
kind:
str
¶
-
rows:
List
[Any
]¶
-
rows_order:
Literal
['initial'
,'random'
]¶
-
rows_visible_if:
str
¶
-
show_header:
bool
¶
-
all_rows_required:
- class questions.MicrophoneQuestion(**data)[source]¶
Bases:
Question
A question that uses the RecordRTC sound recording widgets.
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
extra_js:
- class questions.MultipleTextQuestion(**data)[source]¶
Bases:
Question
A text question with multiple related parts. Displays a text box for each part.
-
col_count:
int
¶
-
item_size:
int
¶
-
items:
List
[Dict
[str
,str
]]¶
-
kind:
str
¶
-
col_count:
- class questions.NoUISliderQuestion(**data)[source]¶
Bases:
Question
A question that uses the NoUISlider JQuery widget.
-
direction:
str
¶
-
extra_css:
List
[HttpUrl
]¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
orientation:
str
¶
-
pips_density:
int
¶
-
pips_mode:
str
¶
-
pips_text:
List
[Union
[int
,str
]]¶
-
pips_values:
List
[int
]¶
-
range_max:
int
¶
-
range_min:
int
¶
-
step:
int
¶
-
tooltips:
bool
¶
-
direction:
- class questions.NumericValidator(**data)[source]¶
Bases:
Validator
Validator for numeric input.
-
kind:
str
¶
-
max_value:
int
¶
-
min_value:
int
¶
-
kind:
- class questions.RadioGroupQuestion(**data)[source]¶
Bases:
ChoicesQuestion
Select one option from a group of radio buttons.
-
kind:
str
¶
-
show_clear_button:
bool
¶
-
kind:
- class questions.RatingQuestion(**data)[source]¶
Bases:
Question
A question that lets the user select a number on a fixed scale.
-
kind:
str
¶
-
max_rate_description:
Union
[str
,Dict
[str
,str
]]¶
-
min_rate_description:
Union
[str
,Dict
[str
,str
]]¶
-
rate_max:
int
¶
-
rate_min:
int
¶
-
rate_step:
int
¶
-
rate_values:
List
[Union
[int
,Dict
[str
,Union
[int
,str
]]]]¶
-
kind:
- class questions.RegexValidator(**data)[source]¶
Bases:
Validator
Checks if a value matches a regular expression.
-
kind:
str
¶
-
regex:
str
¶
-
kind:
- class questions.Select2Question(**data)[source]¶
Bases:
DropdownQuestion
A question that uses the Select2 dropdown widget.
-
extra_css:
List
[HttpUrl
]¶
-
extra_js:
List
[HttpUrl
]¶
-
render_as:
str
¶
-
select2_config:
str
¶
-
extra_css:
- class questions.SignaturePadQuestion(**data)[source]¶
Bases:
Question
Allow the user to “sign” something by drawing their signature. Can be used to capture user drawings for other types of questions.
-
allow_clear:
bool
¶
-
height:
int
¶
-
kind:
str
¶
-
width:
int
¶
-
allow_clear:
- class questions.SortableJSQuestion(**data)[source]¶
Bases:
CheckboxQuestion
A question that uses the JQuery sortable widget.
-
empty_text:
str
¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
max_answers_count:
int
¶
-
empty_text:
- class questions.TagBoxQuestion(**data)[source]¶
Bases:
DropdownQuestion
A question that uses the Select2 tag box widget.
-
extra_css:
List
[HttpUrl
]¶
-
extra_js:
List
[HttpUrl
]¶
-
kind:
str
¶
-
select2_config:
str
¶
-
extra_css:
- class questions.TextQuestion(**data)[source]¶
Bases:
Question
A question that uses a text input box. It can handle all HTML5 text input types.
-
auto_unmask:
bool
¶
-
extra_js:
List
[HttpUrl
]¶
-
input_format:
str
¶
-
input_mask:
str
¶
-
input_type:
Literal
['color'
,'date'
,'datetime'
,'datetime-local'
,'email'
,'month'
,'number'
,'password'
,'range'
,'tel'
,'text'
,'time'
,'url'
,'week'
]¶
-
kind:
str
¶
-
max_length:
int
¶
-
max_value:
str
¶
-
min_value:
str
¶
-
place_holder:
Union
[str
,Dict
[str
,str
]]¶
-
prefix:
str
¶
-
size:
int
¶
-
step:
str
¶
-
text_update_mode:
Literal
['default'
,'onBlur'
,'onTyping'
]¶
-
auto_unmask: