# Titanium.UI.DashboardItem

A dashboard item is a view that is displayed as an icon in a Titanium.UI.DashboardView.

Availability

1.2

9.2.0

Extends

Titanium.Proxy

# Overview

A DashboardItem is created using the Titanium.UI.createDashboardItem method or <DashboardItem> Alloy element.

# Properties

# apiName READONLY

Availability

3.2.0

9.2.0

apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# badge

Availability

1.2

9.2.0

badge :Number

Integer value displayed in a badge.

Set to 0 to reset and remove the badge.

Default: 0

# bubbleParent

Availability

3.0.0

9.2.0

bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# canDelete

Availability

1.2

9.2.0

canDelete :Boolean

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

Default: true

# image

Availability

1.2

9.2.0

image :String | Titanium.Blob

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

# selectedImage

Availability

1.2

9.2.0

selectedImage :String | Titanium.Blob

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

# Methods

# addEventListener

Availability

1.2

9.2.0

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# applyProperties

Availability

3.0.0

9.2.0

applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# fireEvent

Availability

1.2

9.2.0

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

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

Returns

Type: void

# removeEventListener

Availability

1.2

9.2.0

removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void

# Events

# click

Availability

1.2

9.2.0

Fired when a click is detected against the view.

Properties

Name	Type	Description
location	Point	Coordinates `x` and `y` of the event from the parent view's coordinate system.
item	Titanium.UI.DashboardItem	Item that was clicked.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# delete

Availability

1.2

9.2.0

Fired when an item is deleted during editing mode.

Properties

Name	Type	Description
item	Titanium.UI.DashboardItem	Item that was deleted.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# move

Availability

1.2

9.2.0

Fired when an item is moved during editing mode.

Properties

Name	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.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.