Adding a Chart to the Issue Navigator

This page is part of the Gadget Developers' JavaScript Cookbook.

How do I add my chart to the issue navigator view?

1. You must place the gadget in both categories: JIRA and Charts

   <Optional feature="gadget-directory">
       <Param name="categories">
           JIRA
           Charts
       </Param>
   </Optional>
   

2. You must include the following 2 UserPrefs:

   <UserPref name="isPopup" datatype="hidden" default_value="false"/>
   <UserPref name="projectOrFilterId" datatype="hidden" />
   

3. Dynamically change the Configuration field for your gadget's Configuration form:

   config: {
       descriptor: function ()
       {
           var gadget = this;
           var filterField ;
           if (/^jql-/.test(gadget.getPref("projectOrFilterId")) || gadget.getPref("isPopup") === "true"){
               // JQL has been passed in and we should place this in a hidden field
               filterField =
               {
                   userpref: "projectOrFilterId",
                   type: "hidden",
                   value: gadgets.util.unescapeString(gadget.getPref("projectOrFilterId"))
               };
           } else{
               // Lets display the filter picker
               filterField = AJS.gadget.fields.filterPicker(gadget, "projectOrFilterId");
           }
           return  {
               action: "/rest/gadget/1.0/chart/validate",
               theme : "top-label",
               fields: [
                   filterField,
                   { other field }
               ]
           };
       }
   }        
   

   The popup sets the "projectOrFilterId" UserPref to the value jql-<JQL-string>. You don't want to display the filter picker.
4. Your resource should accept the UserPref projectOrFilterId and be able to deal with values of both formats - filter-<filterId> and jql-<JQL string

Refer to the PieChart Gadget for an example of this.

RELATED TOPICS

Gadget Developers' JavaScript Cookbook
Using the Atlassian Gadgets JavaScript Framework