You are reading 12.8.0. See this page in 13.4.1.
Titanium.UI.DashboardItem
Extends Titanium.Proxy
A dashboard item is a view that is displayed as an icon in a Titanium.UI.DashboardView.
A DashboardItem is created using the Titanium.UI.createDashboardItem method or <DashboardItem> Alloy element.
Properties 6
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
badge
NumberInteger value displayed in a badge.
Set to 0 to reset and remove the badge.
Default: 0
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
canDelete
BooleanDetermines whether this item can be deleted when it edit mode.
Default: true
image
String | Titanium.BlobImage or path to image to display in the item by default.
selectedImage
String | Titanium.BlobImage or path to image to display in the item as it is selected.
Methods 4
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| event? | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
Events 3
Fired when a click is detected against the view.
| Event properties | Type | Description |
|---|---|---|
| location | Point | Coordinates |
| item | Titanium.UI.DashboardItem | Item that was clicked. |
Fired when an item is deleted during editing mode.
| Event properties | Type | Description |
|---|---|---|
| item | Titanium.UI.DashboardItem | Item that was deleted. |
Fired when an item is moved during editing mode.
| Event properties | Type | Description |
|---|---|---|
| items | Array<Titanium.UI.DashboardItem> | List of items to be committed, possibly in new order, when edit mode ends. |
| item | Titanium.UI.DashboardItem | Item that was moved. |