Jam.py documentation

filter_options

filter_options

domain: client

language: javascript

class Item class

Description

Use the filter_options attribute to specify parameters of the modal filter form.

filter_options is an object that has the following attributes:

  • width - the width of the modal form, the default value is 560 px,

  • title - use it to get or set the title of the filter form,

  • close_button - if true, the close button will be created in the upper-right corner of the form, the default value is true,

  • close_caption - if true and close_button is true, will display ‘Close - [Esc]’ near the button

  • close_on_escape - if true, pressing on the Escape key will trigger the close_filter_form method.

  • close_focusout - if true, the close_filter_form method will be called when a form loses focus

  • template_class - if specified, the div with this class will be searched in the task templates attribute and used as a form html template when creating a form

Example

function on_filter_form_created(item) {
    item.filter_options.width = 700;
}