Object Drop-down

Deprecation Warning! The content below is only applicable for use within deprecated 1.x versions of Rally's App SDK. Use of the component(s) and/or code on this page is not supported. To develop custom apps within our current environments, please see App SDK 2.0 documentation.

The Object Drop-down component allows you to easily create a drop-down populated with Rally data. The drop-down supports mouse selection as well as autofiltering in response to key strokes.

object

Object Drop-down includes the following topics:

Create an Object Drop-down

First include the App SDK javascript:

<script type="text/javascript" src="/apps/[version]/sdk.js"></script>

Instantiate a new ObjectDropdown:

var dropdown = new rally.sdk.ui.ObjectDropdown(config, rallyDataSource);

The parameters for rally.sdk.ui.ObjectDropdown are as follows:

Parameter Description Example
config* An Object Drop-down configuration object { type: "hierarchicalrequirement", attribute: "Name",
query: '(ScheduleState = "In-Progress")' }
rallyDataSource* An instance of rally.sdk.data.RallyDataSource new rally.sdk.data.RallyDataSource
   ("__WORKSPACE_OID__",
    "__PROJECT_OID__",
   "__PROJECT_SCOPING_UP__",
    "__PROJECT_SCOPING_DOWN__")
  * = required parameter

The Object Drop-down configuration object supports the following properties:

Parameter Description Example
type* Specify the Rally object type. "defect", "hierarchicalrequirement", "task"
attribute* The object field displayed in the drop-down. "Name", "FormattedID"
showLabel
If showLabel is true, then the label will be shown.
Defaults to true if label is specified, false otherwise.
true
label
The text for the description that will be placed next to the drop-down.
"Label Text"
labelPosition
Where the label will be displayed, either before or after.
"before"
query A filter clause to be applied to the object query.
May be a string or a Query object (default = "").
'(ScheduleState = "In-Progress")'
order An order by clause to be applied to the object query (default = ""). "CreationDate"
fetch A comma-separated list of additional fields to include in the query. "State, Owner"
rememberSelection
Whether to persist the current selection as the default for future sessions (default = true).
false
defaultDisplayValue
The first display value the drop-down will be set to. If rememberSelection is true, the remembered value is given priority over this default.
"Defect 1"
defaultValue
The first value the drop-down will be set to.
If rememberSelection is true the remembered value is given priority over this default.
"/defect/12345"
width Specify the drop-down's width in pixels.
By default the drop-down will be sized according to its contents.
200
  * = required parameter

Display an Object Drop-down

Once created, use the display method to query Rally for the specified data and then show the drop-down:

dropdown.display(domElement, onChangedCallback);

Parameter Description Example
domElement* The element in which to display the drop-down.
This may be either an element or an element ID.
"dropdownDiv",
document.getElementById("dropdownDiv")
onSelectionChanged A function which will be called when the value of the drop-down has changed.
The function will be invoked passing the source drop-down as the sender parameter and an object containing
information about the currently selected item as the eventArgs parameter.
function onSelectionChanged(sender,
eventArgs) {
   var selectedValue = args.value;
   var selectedDisplayValue =
args.displayedValue;
}
  * = required parameter

Public methods

Method Name Parameters Description Example
display See above - See above
destroy - Removes this component. dropdown.destroy();
getDisplayedValue - Returns the displayed value of the currently selected item in the drop-down. "Document Components"
getValue - Returns the value of the currently selected item in the drop-down. "https://rally1.rallydev.com/slm/webservice/1.26/hierarchicalrequirement/111111111.js"
getItems - Returns an array of the raw data contained in the drop-down. [ { Name: "UserStory1", ObjectID: "111111111", _ref: "https://rally1.rallydev.com/slm/webservice/1.26/hierarchicalrequirement/111111111.js" }, ... ]
getSelectedItem - Returns the currently selected item.
This method is useful for retrieving any additional fields
specified in the constructor config's fetch attribute.
{label: "Selection1", value: "Selection1"}
setDisplayedValue displayedValue* Set the selected item of the drop-down based on the specified display value. dropdown.setDisplayedValue("Search for Items");
setValue value* Set the selected item of the drop-down based on the specified value. dropdown.setValue(itemRef);
  * = required parameter

Events

Events are used to notify consumers of a component when actions occur.
The following methods are provided in order to interact with this component's events:

Method Parameters Description Example
addEventListener eventName*, listener*, scope Registers the specified listener with the component's queue for the specified event and returns an object which can be used to remove the event listener later. The listener parameter should be a function with two parameters: 1) the component that fired the event; 2) an eventArgs object with properties specific to the event being fired. This function will be called by the component when the event occurs. If the optional scope parameter was specified the function will be called on that object (like scope.listener(sender, args);). function listener(sender, eventArgs) {
   //Respond to event
}
var eventObj = component.addEventListener(eventName,
listener);
removeEventListener eventObj* Unregisters the specified event from the component.
The eventObj parameter should be the return value of addEventListener() when the listener was originally registered.
var eventObj = component.addEventListener(...); component.removeEventListener(eventObj);
getValidEvents - Returns an object with a property for each event name supported by the component. This is useful for passing as the first parameter to addEventListener(). var eventName = component.getValidEvents().onClick;
  * = required parameter

The Drop-down component supports the following events:

Event Name Description Event Arguments Example
onChange Fired when a new value is selected

The eventArgs object passed to any event listeners
contains the following properties:

value: Returns the underlying value for the drop-downs current selection.
displayedValue: Returns the underlying displayed text for the drop-downs current selection.
item: Returns the object value that was used for the current selection.

dropdown.addEventListener("onChange",
   onChangeEventListener);
onLoad Fired when the component is loaded The eventArgs object passed to any event listeners contains the following properties:

value: Returns the underlying value for the drop-downs current selection.
displayedValue: Returns the underlying displayed text for the drop-downs current selection.
items: Returns all the items used to display this component.
item: Returns the object value that was used for the current selection.
dropdown.addEventListener("onLoad",
   onLoaded);
onDataRetrieved Fired when the drop-down data has been retrieved but before it is bound (useful for adding or removing items, sorting, and so on) The eventArgs object passed to any event listeners contains the following properties:

items: An array of the retrieved items.
displayValueProperty: The property name corresponding to the display value of each item.
valueProperty: The property name corresponding to the value of each item.
function onDataRetrieved(a, eventArgs) {
   //Add an "All" option
   var all = {};
   all[eventArgs.displayValueProperty] = "All";
   all[eventArgs.valueProperty] = "All";
   eventArgs.items.unshift(all);
}
dropdown.addEventListener("onDataRetrieved",
   onDataRetrieved);

Example

Copy and paste the following into a Rally custom page.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!-- Copyright (c) 2011 Rally Software Development Corp. All rights reserved -->
<html>
<head>
    <title>Object Dropdown Example</title>
    <meta name="Name" content="Component Example: Object Drop-down" />
    <meta name="Version" content="1.26" />
    <meta name="Vendor" content="Rally Software" />

    <script type="text/javascript" src="/apps/1.26/sdk.js"></script>
    <script type="text/javascript">

       function dropdownChanged(dropdown, eventArgs) {
          var selectedItem = eventArgs.item;
          var selectedValue = eventArgs.value;
       }

       function onLoad() {
          var rallyDataSource = new rally.sdk.data.RallyDataSource('__WORKSPACE_OID__',
                                                             '__PROJECT_OID__',
                                                             '__PROJECT_SCOPING_UP__',
                                                            '__PROJECT_SCOPING_DOWN__');

          var config = {
                type : "defect",
                attribute: "Name",
                query : '((State = "Open") AND (Priority = "High Attention"))'
             };
          var objectDropdown = new rally.sdk.ui.ObjectDropdown(config, rallyDataSource);
             objectDropdown.display("aDiv", dropdownChanged);
       }

       rally.addOnLoad(onLoad);

    </script>
</head>
  <body>
    <div id="aDiv"></div>
</body>
</html>

Feedback

Need more help? The CA Agile Central Community is your one-stop shop for self-service and support. To submit feedback or cases to CA Agile Central Support, find answers, and collaborate with others, please join us in the CA Agile Central Community.