# Titanium.UI.DashboardItem

> A dashboard item is a view that is displayed as an icon in a [Titanium.UI.DashboardView](https://titaniumsdk.com/docs/sdk/Titanium.UI.DashboardView.md).

- Source: https://titaniumsdk.com/docs/sdk/13.0.1/Titanium.UI.DashboardItem
- Titanium SDK version: 13.0.1
- Kind: proxy
- Platforms: iPhone, iPad, macOS
- Since: Titanium SDK 1.2
- Extends: Titanium.Proxy
- Inheritance: Titanium.Proxy

A DashboardItem is created using the [Titanium.UI.createDashboardItem](https://titaniumsdk.com/docs/sdk/Titanium.UI.md#createDashboardItem) method or **`<DashboardItem>`** Alloy element.

## Properties

### badge

- Type: Number
- Platforms: iPhone, iPad, macOS
- Default: `0`

Integer value displayed in a badge.

Set to `0` to reset and remove the badge.

### canDelete

- Type: Boolean
- Platforms: iPhone, iPad, macOS
- Default: `true`

Determines whether this item can be deleted when it edit mode.

### image

- Type: String | Titanium.Blob
- Platforms: iPhone, iPad, macOS

Image or path to image to display in the item by default.

### selectedImage

- Type: String | Titanium.Blob
- Platforms: iPhone, iPad, macOS

Image or path to image to display in the item as it is selected.

## Events

### click

- Platforms: iPhone, iPad, macOS

Fired when a click is detected against the view.

Event properties:

- `location` (Point): Coordinates `x` and `y` of the event from the parent view's coordinate system.
- `item` (Titanium.UI.DashboardItem): Item that was clicked.

### delete

- Platforms: iPhone, iPad, macOS

Fired when an item is deleted during editing mode.

Event properties:

- `item` (Titanium.UI.DashboardItem): Item that was deleted.

### move

- Platforms: iPhone, iPad, macOS

Fired when an item is moved during editing mode.

Event properties:

- `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.

## Inherited members

6 members are inherited. Each is documented on the type that declares it.

- [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/13.0.1/Titanium.Proxy.md): `addEventListener`, `apiName`, `applyProperties`, `bubbleParent`, `fireEvent`, `removeEventListener`

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.

