21
Thu, Nov
1 New Articles

TechTip: Introduction to GridX for Dojo Developers

General
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

 

Learn the basics of GridX, an open-source JavaScript library that makes it easy to create sophisticated interactive tables for the web.

 

What is GridX? GridX is a library created to display data stores in a table. It's a great alternative to Dojo's native dojox.grid. It comes with many modules that add additional features to a basic table and is designed to be easily extended by users' modules.

Basic GridX Examples

We'll start out using a memory store and then advance to using JSON REST stores and some of the more interesting features GridX provides.

 

Example with a Memory Store

 

The following makes a simple GridX table that displays three entries.

 

Figure 1: Simple GridX Example with Memory Store

 

The code that creates it is the following:

 

// GridX example with memory store

test_func: function() {

   this.test = new Grid({

       store: new MemoryStore({

           data: [

             {

                   id: 1, // unique id used by GridX functions.

                   name: "Randy",

                   location: "Raleigh"

               },

               {

                   id: 2,

                   name: "Arun",

                   location: "Austin"

               },

               {

                   id: 3,

                   name: "Susan",

                   location: "Rochester"

               }

           ]

       }),

       cacheClass: "gridx/core/model/cache/Sync", //Cache

       structure: [

           {

               id: "id"/*this.test.column.id*/,

               field: "id"/*field in store data*/,

               name: "ID" /*displayed in column header*/

           },

          {

               id: "name",

               field: "name",

               name: "Name"

           },

           {

               id: "location",

               field: "location",

               name: "Location"

           }

       ],

      modules: [ ColumnResizer ],

       autoHeight: true

   // needed for grids not put in the entire pane. otherwise grid doesn't display

   });

   this.set('content', this.test); // set the grid in the template

 

}

 

Figure 2: Simple GridX Code with Memory Store

 

Breaking this down, we gave the new GridX five parameters.

 

    • Store: This store contains the data. In this example, we used a memory store, but in the next example, we will use a JSON REST store.

 

    • CacheClass: This can be synchronous or asynchronous. Since we're using a memory store, we use the synchronous cache.

 

    • Structure: This describes how the data will be displayed in the table. Each object in the array describes a column. The three parameters GridX needs are 1) a unique ID, 2) a field name from the data, and 3) a name for the column header. There are other parameters you may specify. We'll talk about them in later examples.

 

    • Modules: I couldn't resist putting at least one in. These are optional, but they provide extended functionalities for the table. In this example, I included the Column Resizer module, which allows the table columns to be resized.

 

    • AutoHeight: This parameter is not necessary, but it tells the table to calculate its height based on the number of rows it has. This creates a variable length table. If "autoHeight" is false (default), then the GridX will fill the space available to it and provide a scrollbar if the space required exceeds the space available.

 


Lastly, we placed the GridX in the pane. In this example, "this" referred to a content pane. Thus, we filled the content pane with the grid.

 

Example with a JSON REST Store

In this example, we used a JSON REST store, rather than a memory store, to get the data from a server.

 

Figure 3: Simple Example with a JSON REST Store

 

The code for this is as follows:


// GridX example with json store

test_func2: function() {

   this.test = new Grid({

       store: new JsonRestStore({

           root: "images",

           target: "ourUrl/images"

       }),

       cacheClass: "gridx/core/model/cache/Async",

       structure: [

           {

               id: "id",

               field: "id"/*field in store data*/,

               name: "ID" /*displayed in column header*/

           },

           {

               id: "name",

               field: "name",

               name: "Name"

           },

           {

               id: "status",

               field: "status",

               name: "Status",

             formatter: function(item) {

                   return item.status.toUpperCase();

               }

           }

       ]

   });

   this.set('content', this.test); // set the grid in the template

}

 

Figure 4: Simple Code with a JSON REST Store

 

Notice a couple of differences. First, since we didn't use auto height, the grid is larger than it needs to be, filling the space available to it. Second, since we're using a JSON REST store, the cache is asynchronous. Third, the status column has been formatted. The formatting is done in the optional structure formatter. The formatter is a function whose input is the data from the store; it returns a string with the formatted data. In this case, the status string was made uppercase.

 

The JSON REST store only needs two parameters: the root and the target. The data from the server is formatted like this:

 

{

"images":

[

   {"status": "active", "name": "test", "id": "0e305793-5b35-4823-961b-573ac2bf89cd"},

   {"status": "active", "name": "test", "id": "d712d2e4-2e18-4802-8e64-82b15a7ec61a"}

],

}

 

So "images" is the root of the store.

More Fun with GridX

Here are a few examples of things you can do with GridX.

 

Example with Clickable Rows

Calling a function when a row is clicked on requires only a few modifications to the code in Figure 3.

 

onRowClick: lang.hitch(this, function(e) {

   alert("You clicked row " + e.rowId + "!"); // nothing selected

})

 

The onRowClick function will trigger the provided function every time a row is clicked on. There are also functions for cell select and column select.

 

Example with Selectable Rows

GridX provides modules for row selection and extended row selection. Since extended row select allows multi-select by swiping, it's considered more mobile-friendly. The functions under this.test.select.row allow for gathering data from the row selected.

 

modules: [ExtendedSelectedRow],

selectRowTriggerOnCell: true,

onRowClick: lang.hitch(this, function() {

   alert("You clicked row " + this.test.select.row.getSelected()[0] + "!");

})

 

The getSelected function returns an array of row IDs. You may look up the row data by using the ID. For example:

 

this.test.model.byId(this.test.select.row.getSelected()[0]);

this.test.select.row.model.byId(this.test.select.row.getSelected()[0]);

 

Example with Status Icons

A common table design is to have an icon along some status text in a table column. This is simple to do with the GridX decorator and CSS.

 

{

   id: 'status',

   field: 'status',

   name: 'Status',

   decorator: function(formattedValue, rowId, visualIndex, cell) {  

       return '<div class="imageStatus' + formattedValue + '">'

               + formattedValue + '</div>';

   }

}

 

The cascading style sheet contains classes with the icons. These classes are named according to the statuses returned from the server.

Wrapping It Up

With GridX, you can make sophisticated tables without having to reinvent the wheel. For more information, GridX has a great home page including API documentation and tutorials.

Danielle Carmon

Danielle Carmon is a Software Developer at IBM in Raleigh, NC. She has been working in Cloud Systems Software Development on Javascript-based UIs since 2012.

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: