25
Thu, Apr
1 New Articles

TechTip: Custom Sorting with GridX

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

 

Learn how to do custom sorting with GridX. GridX is an opensource JavaScript library that makes it easy to create sophisticated interactive tables for the web.

 

Why use special sorting?

 

GridX will do sorting for you if you use the sort module, but custom sorting is a subtle tweak to enhance the user's experience. If you're just interested in basic sorting (specifying an initial sort order, etc.), GridX has documentation here. If you don't specify a customized sort method, GridX will use the standard sorting for the data type. However, frequently you will need something more sophisticated than an alphabetical sort for strings. Also, what if your column is displaying data from an object? GridX will have no idea how the objects should be sorted unless you specify a custom sort.

 

Some Examples

Fortunately, GridX makes adding a custom sorting for a column easy. For these examples, you'll want to use the sort module "gridx/modules/Sort" and the formatted sort extension "gridx/core/model/extensions/FormatSort." You specify the model extensions just like you would specify modules:

 

new Grid({

   modules: [

       Sort

   ],

   modelExtensions: [

       FormatSort

   ]

   // plus your other grid properties

});

 

Sorting by Format

Sometimes all you need is formatted sort. Suppose you have a column displaying an object:

 

host: {

   name: "MyHost",

   id: "23anr49sjc9322341"

}

 

If you're only displaying the name property of that object in the column, you can specify sortFormatted true, and GridX will use a standard alphabetical sort on the formatted data:

{

 id : "host", field : "host", name : "Host",

   formatter: function(data) { return data.name; },

   sortFormatted: true

}

 

121914CarmonFigure1

Figure 1: Here's an example of using formatted sort.

 

Sorting by Status

What if you find yourself needing something other than an alphabetical sort? For example, if you want to display a status column by order of severity, you'll need to do a custom sort. GridX allows you to specify your own comparator. In the code below, the status is info, warning, or fail. We sort them so the failure messages come to the top. In addition to the ID, field, name, formatter, and decorator, we specify a comparator. The comparator returns a truthy value if the first argument should be ordered above the second.

 

{

   id: 'status',

   field: 'status',

   name: "Status",

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

       var status = cell.grid.getModelData(cell);

       status = status ? status.toLowerCase() : "unknown";

       return "<div class='" + styleMap[status.toLowerCase()] +

               "'></div>" + formattedValue;

   },

   formatter: function(obj) {

       strings = {

           "success": "Success",

           "info": "Information",

           "fail": "Error",

           "unknown": "Unknown"

       }

       return strings[obj.status];

   },

   comparator: function(v1, v2) {

       var mapping = {

           "success": 1,

           "info": 2,

           "fail": 3

       };

       return mapping[v1] - mapping[v2];

   }

}

 

The column will look like this:

 

121914CarmonFigure2

Figure 2: This example uses sorting status.

 

Sorting by IP Addresses

Another case where you need a custom sort would be IP addresses. At first it may seem like a string sort will work9.5.126.181 is greater than 9.5.126.180. Looking more closely, though, 9.5.126.181 is also greater than 10.5.126.180. Oops. But now we know how to fix this. We use the comparator, just as before, and we use our own function (utils.ipToDecimal) to convert the IP address to numbers corresponding to the correct order.

 

{

   id: 'ip',

   field: 'ip',

   name: "IP Address",

   comparator: function(ip1, ip2) {

      return utils.ipToDecimal(ip1) - utils.ipToDecimal(ip2);

   }

}

 

121914CarmonFigure3

Figure 3: In this example, we sort by IP addresses.

 

Sorting by Objects

The GridX wiki has an excellent example for sorting date objects here. I've provided a simple example below where you display a range "min – max" but sort by the average. Notice that in this case sortFormatted shouldn't be true; otherwise, the arguments to the comparator would be values returned from the formatter.

 

{

   id: 'range',

   field: 'range',

   name: "Range",

   formatter: function(obj) {

       return obj.min + " - " + obj.max;

   },

   comparator: function(item1, item2) {

      return item1.min + item1.max – item2.min – item2.max;

   }

}

 

Sorting the Sort Modules Out

You will need custom sorting for all but the simplest data. Fortunately, GridX provides multiple flexible and easy ways to handle all kinds of sorting. In this TechTip, I used the GridX Sort module, but for basic sorting you might only want SingleSort or NestedSort.

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

$0.00 Raised:
$

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: