AMI Web Framework API > Interface > IContainer
ami.IContainer
The AMI container interface
Methods
render(selector, options) ->{$.Promise}
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| selector | string | the selector | |||
| options | Object.<string, *> | dictionary of optional parameters (...) | {} | ✓ |
Returns:
A JQuery promise object
Type: $.Promise
prependItem(title, options) ->{$.Promise}
Prepends an item
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| title | string | the title | |||
| options | Object.<string, *> | dictionary of optional parameters (...) | {} | ✓ |
Returns:
A JQuery promise object returning the new item's identifier
Type: $.Promise
appendItem(title, options) ->{$.Promise}
Appends an item
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| title | string | the title | |||
| options | Object.<string, *> | dictionary of optional parameters (...) | {} | ✓ |
Returns:
A JQuery promise object returning the new item's identifier
Type: $.Promise
removeItem(itemId)
Removes an item
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| itemId | string | the item identifier |
removeAllItems()
Removes all items
isEmpty() ->{boolean}
Checks whether the container is empty or not
Returns:
Type: boolean