Create an input widget capable of textual input, validations and autocompletion. Keyword arguments which are applicable to input tags are passed through. Other keyword arguments are sent to the Javascript widget.

Parameters:

• id - The id of the widget
• name - The name of the widget. Default: same as id
• type - The type of the input tag (text/password/button/checkbox/radio/image etc.). Default: text
• validator - A single or list of strings which are names of javascript callables. Each callable must return either true/false or an object where object.result = (true or false) and object.message = (return message). Validation fails if any callable returns false in the result.
• autocomplete - The url of the datasource (returning data delimited by newlines). Default: None
• autocomplete_options - A dictionary of autocomplete options to be passed directly to the autocompleter

Create a grid

Using Grids

To use a grid which stores data on the server, a server side control must first be initialized.

>>> grid_id = iris.root.set_control_data(grid_data, id="my_grid")

The id is optional and autogenerated if not specified.

In your template file, create a grid tag as follows (The example uses Cheetah Templating syntax):

$widgets.grid_tag($grid_id, width="800px", columns=["Name", "Place", "Animal", "Thing"], toolbar=False) This will generate a div and associated script tag which will render a 4-column grid which is 800px wide and does not have a toolbar.

Parameters:

• id - The id of the grid as returned by iris.root.set_control_data
• url - A url of the custom json data source to use. Default: The url is generated from the id.
• data - A list of dictionaries to be used as the data for the grid. Default: The data is loaded from the url.
• datalength - If this is provided, then the datasource downloads the data in optimized chunks.
• width - A css value for width. Default: auto
• columns - A list of column names or dictionaries. Default: Automatically calculated
• groupby - An ordered list of column names to group by. Default: [] (no grouping)
• filterable - Boolean value denoting whether or not the rows can by filtered by column value. Default: True. Disable this to improve performance.
• sortable - Boolean value denoting whether or not the rows can by sorted. Default: True. Disable this to improve performance.
• pagesize - The number of items to show per page. Default: 25. If pagesize is negative or None, the table is not paginated.
• printable - Boolean value denoting whether or not the "Print" button should be shown on the toolbar. Default: True.
• excel - Boolean value denoting whether or not the "Export to Excel" button should be shown on the toolbar. Default: True. This option is not available if the data keyword argument is provided.
• toolbar - Boolean value denoting whether or not the toolbar should be shown. If the toolbar is hidden, all buttons on it are also hidden and hence inaccessible. Default: True.

Render a chart using an IFRAME

Parameters:

• id - The id of the chart data as returned by iris.root.set_control_data
• ch_type - A charting constant as defined in the widgets module.
• width (int) - Width of the chart in pixels.
• height (int) - Height of the chart in pixels.
• columns - A list of column names to be used as the series.
• url - A url of the custom json data source to use. Default: The url is generated from the id.
• data - A list of data values for the chart. Default. The data is loaded from the URL.

input_attributes

Value:

'type', 'name', 'value', 'size', 'maxlength', 'checked', 'src', 'class ', 'id', 'dir', 'lang', 'title', 'style', 'align', 'alt', 'accept', 'r eadonly', 'disabled', 'tabindex', 'accesskey', 'ismap', 'usemap', 'onf ocus', 'onblur', 'onselect', 'onchange', 'onclick', 'ondbclick', 'onmo usedown', 'onmouseup', 'onmouseover', 'onmousemove', 'onmouseout', 'on keypress', 'onkeydown', 'onkeyup'

grid_keys

Value:

'pagesize', 'columns', 'groupby', 'filterable', 'sortable', 'width', ' toolbar'

notification_keys

Value:

'delay', 'duration', 'width', 'height', 'image'