Titanium.UI.DashboardItem
> Titanium.UI.DashboardItem

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.

  • 1.2
  • 1.2
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

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, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Titanium.UI.DashboardItem
: Number
Integer value displayed in a badge. ...

Integer value displayed in a badge.

Set to 0 to reset and remove the badge.

Default: 0

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

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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.UI.DashboardItem
: Boolean
Determines whether this item can be deleted when it edit mode. ...

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

Default: true

Titanium.UI.DashboardItem
image : String/Titanium.Blob

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

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

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

  • 3.6.0
Titanium.UI.DashboardItem
selectedImage : String/Titanium.Blob

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

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

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Titanium.UI.DashboardItem
( ) : Number
Gets the value of the badge property. ...

Gets the value of the badge property.

Returns

  • Number
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Titanium.UI.DashboardItem
( ) : Boolean
Gets the value of the canDelete property. ...

Gets the value of the canDelete property.

Returns

  • Boolean
Titanium.UI.DashboardItem
( ) : String/Titanium.Blob
Gets the value of the image property. ...

Gets the value of the image property.

Returns

Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.UI.DashboardItem
( ) : String/Titanium.Blob
Gets the value of the selectedImage property. ...

Gets the value of the selectedImage property.

Returns

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

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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Titanium.UI.DashboardItem
( badge )
Sets the value of the badge property. ...

Sets the value of the badge property.

Parameters

  • badge : Number

    New value for the property.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.DashboardItem
( canDelete )
Sets the value of the canDelete property. ...

Sets the value of the canDelete property.

Parameters

  • canDelete : Boolean

    New value for the property.

Returns

  • void
Titanium.UI.DashboardItem
( image )
Sets the value of the image property. ...

Sets the value of the image property.

Parameters

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.UI.DashboardItem
( selectedImage )
Sets the value of the selectedImage property. ...

Sets the value of the selectedImage property.

Parameters

Returns

  • void
Defined By

Events

Titanium.UI.DashboardItem
Fired when a click is detected against the view. ...

Fired when a click is detected against the view.

Properties

  • location : Dictionary

    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.

    •  
    •  
    •  
Titanium.UI.DashboardItem
Fired when an item is deleted during editing mode. ...

Fired when an item is deleted during editing mode.

Properties

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

    •  
    •  
    •  
Titanium.UI.DashboardItem
Fired when an item is moved during editing mode. ...

Fired when an item is moved during editing mode.

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.

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

    •  
    •  
    •