[deprecated] RockGrid - powerful, performant and beautiful data listing tool

[Mustafa-Online]

@bernhard , @theo ___ How can I add "CRUD" operations to the grid? and also make a title as Link to the page?

[bernhard]

Crud will not be that easy. It's easier to open pages in a panel via the regular PW page editor. Linking the page title is very easy using cell renderers. See the aggrid docs.

[Beluga]

I've been looking into External filter. There is a problem, though: rockgrid.js gets loaded in the head element, so we cannot use an external element rendered outside rockgrid.js. I am having trouble figuring out how I should go about using and rendering markup that goes outside the grid in rockgrid.js. Or should I just modify things so that rockgrid.js loads at the end of the document?

[bernhard]

Sorry @Beluga but I don't understand your question. What is the exact szenario? What is the exact problem? You have all the aggrid api available with all your RockGrids. The most important events are BeforeInit and AfterInit, then you have your RockGrid instances available for any further actions.

[Beluga]

The idea is to have an additional dropdown to filter the items. It is not possible to have two filters in the same column, so I have to use the external filter feature. Thanks for nudging me in the right direction. I include a minimised version of my current code.

When I started writing this reply, I was stuck, but I continued banging my head against the wall. Now I have a solution, where the dropdown completely overrides the smart filter. This might actually be useful, as then you can filter further (by typing) the already filtered content, but I should turn it off by default and include a checkbox to control it.

Something that I don't understand is: why do I have to have both onchange="" in the select element and the addEventListener for the thing to work? I hope it will not be troublesome to create the checkbox solution to control the listener (tips welcome, I'm taking a break).

Edit: I added a checkbox and tied the isExternalFilterPresent function to it and now it is perfect to me!

document.addEventListener('RockGridItemBeforeInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var grid = RockGrid.getGrid(e.target.id);
  grid.gridOptions.isExternalFilterPresent = isExternalFilterPresent;
  grid.gridOptions.doesExternalFilterPass = doesExternalFilterPass;
  
  var col = grid.getColDef('code');
  col.headerName = grid.js.code;

  var col = grid.getColDef('variation');
  col.headerName = grid.js.variation;

  col.filter = RockGrid.filters.smart;
  col.floatingFilterComponent = RockGrid.filters.smartFloating;

});

var grid = null;
var eFilterText = null;
var dropcheck = null;

document.addEventListener('RockGridItemAfterInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var col;
  var colDef;
  grid = RockGrid.getGrid(e.target.id);
  grid.setColumns(['code', variation]);
  var selectoptions = '';
  // let's build the select element and its options by using a pre-populated object
  // with key:value pairs like A1a:"water and fire as natural elements"
  var codeskey = Object.keys(codesarray);
  Object.values(codesarray).forEach(function(item, index) {
      selectoptions += '<option value="' + codeskey[index] + '">' + item + '</option>';
  });
  var dropgui = document.createElement('div');
  dropgui.innerHTML = '<select id="filterText" onchange="externalFilterChanged(eFilterText, grid)">' + selectoptions + '</select><input id="dropcheck" type="checkbox" onchange="externalFilterChanged(eFilterText, grid)" />';
  e.target.prepend(dropgui);

  dropcheck = document.getElementById('dropcheck');
  eFilterText = document.getElementById('filterText');
  eFilterText.addEventListener("change", externalFilterChanged(eFilterText, grid));
});

var filterText = null;

// dropdown filter is present, if the checkbox is checked
function isExternalFilterPresent() {
  return (dropcheck !== null && dropcheck.checked);
}

// this is given a rowNode by ag-Grid
function doesExternalFilterPass(node) {
  var passed = true;  
  var filterWord = filterText.toLowerCase();
  var value = node.data.code;
  if (value === null) value = '';
  if (value.toString().toLowerCase().indexOf(filterWord) < 0) {
      passed = false;
  }
    
  return passed;
}

function externalFilterChanged(eFilterText, grid) {
  filterText = eFilterText.options[eFilterText.selectedIndex].value;
  grid.gridOptions.api.onFilterChanged();
}

 

[bernhard]

Glad my answer helped you somehow. I don't have time to look into that in detail. You can have a look at how I built the smartfilter. It's a 100% custom filter and you can build your very own filter as well.

I'd be happy to help you if you are building something like the https://www.ag-grid.com/javascript-grid-filter-set/ , because that's definitely something others (including me) would benefit of.

You might also want to use my debounce function so that the filter does not fire on every single key press.

[bernhard]

1 hour ago, Beluga said:

It is not possible to have two filters in the same column, so I have to use the external filter feature.

BTW: My smart filter does already support multiple filters (AND and OR)

>50 <100

would list all items that are above 50 and below 100

ber bau

would find Bernhard Baumrock, but not "Bernhard Muster"

bernhard | beluga

would find both "Bernhard Baumrock", "Bernhard Muster" AND "beluga"

 

PS: So maybe you could just create a custom button wherever you want that sets my smart filter to one of those options. Even Regex is possible.

[bernhard]

Just pushed v0.0.14 to github - caution, there is a BREAKING CHANGE (but a small one ? )

Initially I implemented a concept of column definition plugins to reuse column modifications ( for example you almost always want icons to show/edit/delete the row instead of showing the page id). Now that works with helper functions that are available through the RockGrid.colDefs object (and you can of course extend that with your own helper functions).

It's easy to create those functions:

document.addEventListener('RockGridReady', function(e) {
  RockGrid.colDefs.fixedWidth = function(col, width) {
    col.width = width || 100;
    col.suppressSizeToFit = true;
    return col;
  };
});

And using them is a lot easier than before:

// before
grid.addColDefPlugins({
	id: 'rowactions',
});

var col = grid.getColDef('id');
col.headerName = 'ID';
col.width = 70;
col.suppressSizeToFit = true;
col.suppressFilter = true;
col.pinned = 'left';


// after
var col = grid.getColDef('id');
col = RockGrid.colDefs.rowActions(col);
col.pinned = 'left';

It will replace your ID with those icons:

 

There are plugins available to add your custom actions to that column (or any other column) and you can even combine those plugins:

  col = grid.getColDef('title');
  col = RockGrid.colDefs.fixedWidth(col, 100);
  col = RockGrid.colDefs.addIcons(col, [{
    icon: 'file-pdf-o',
    cls: 'pw-panel',
    dataHref: function(params) {
      if(!params.data.pdfs) return;
      var pdfs = params.data.pdfs.split(',');
      if(!pdfs.length) return;
      return '/site/assets/files/' + params.data.id + '/' + pdfs[pdfs.length-1];
    },
    label: function(params) {
      return 'show invoice PDF ' + params.data.id;
    },
  }]);

 

[Beluga]

I solved my external filter setup with a checkbox (edited the original code block with the changes) and I am happy! I can create a series of screenshots during the weekend to illustrate how it works ?

[bernhard]

The latest version makes it possible to put your rockgrid files in a custom directory. That's handy (necessary) when you are developing modules that ship with rockgrids. A processmodule would be as simple as that:

  /**
   * manage all lists
   */
  public function executeLists() {
    $form = $this->modules->get("InputfieldForm");

    $form->add([
      'type' => 'RockGrid',
      'name' => 'lists',
      'assetsDir' => __DIR__."/grids",
    ]);
    
    return $form->render();
  }

 

[Beluga]

Screenshot demo of the external filter code in my comment:

[Beluga]

Here is how I do linkifying, any tips for improvements or alternatives welcome:

In rockgrid.php I include 'name' as a column, but then in RockGridItemAfterInit I do grid.setColumns(['code', 'variation']); to make it hidden.

I have these to get the urls I want:

var url = document.URL;
// URL API's origin gets us a href of the hostname without the trailing slash (does not work with IE11)
var domain = new URL(url).origin;

For the 'variation' column I have a cellRenderer to link to the children of the page using the 'name' column data:

col.cellRenderer = function(params) {    
  if(params.value !== null) {
  return '<a href="' + url + params.data.name + '">' + params.value + '</a>';
  }
}

For the 'code' column I have a valueGetter to pull the human-readable name for the category from a JS object and stick it after the code. Then I use a cellRenderer to link the text to anywhere I want:

// let's combine the code with its meaning
col.valueGetter = function(params) {    
  return params.data.code + ' ' + codesarray[params.data.code];
}
col.cellRenderer = function(params) {    
  return '<a href="' + domain + '/clas2/">' + params.value + '</a>';
}

 

[bernhard]

Glad to see RockGrid in action, thx for the screenshots ?

21 minutes ago, Beluga said:

Here is how I do linkifying, any tips for improvements or alternatives welcome:

What kind of improvements do you mean? Only thing I can think of is that you use ActionIcons for that. You can add them before or after the cell content. And you can show them always or only on hover:

Sample code is some posts above, see RockGrid.colDefs.addIcons()

PS: On non-fixed-width columns it's better to add icons BEFORE so that they are still visible even if the cell has more content than can be displayed.

 

[bernhard]

Pushed v0.0.16: Now you can also set a custom assets folder in the field's config:

[Beluga]

2 hours ago, bernhard said:

What kind of improvements do you mean?

Those kinds that I can't think of before I hear them ?

[bernhard]

3 hours ago, Beluga said:

Those kinds that I can't think of before I hear them ?

So, did my comment help? https://processwire.com/talk/topic/19539-rockgrid-powerful-performant-and-beautiful-data-listing-tool/?do=findComment&comment=175553

 

[Beluga]

1 hour ago, bernhard said:

So, did my comment help? https://processwire.com/talk/topic/19539-rockgrid-powerful-performant-and-beautiful-data-listing-tool/?do=findComment&comment=175553

 

Not really, so I guess my solution is perfect for my case ?

[Beluga]

I am having trouble with events. In my RockGridItemAfterInit block I have

grid.gridOptions.onFilterChanged = afterFilter();

Then outside it the function

function afterFilter() {
    console.info("filter changed");
}

The function fires exactly once - when the grid is initialised. It does not fire when the filters are changed.

If I instead use

grid.gridOptions.api.addEventListener('filterChanged', afterFilter());

It fires when the grid is initialised and when I change a filter, I get this in the console (the first time, on further tries I get nothing):

TypeError: t is not a function ag-grid.min.js:26:2395
    p</e.prototype.dispatchToListeners/</< http://0.0.0.0/site/modules/FieldtypeRockGrid/lib/ag-grid.min.js:26:2395
    p</e.prototype.flushAsyncQueue/< http://0.0.0.0/site/modules/FieldtypeRockGrid/lib/ag-grid.min.js:26:2814
    forEach self-hosted:262:13
    p</e.prototype.flushAsyncQueue http://0.0.0.0/site/modules/FieldtypeRockGrid/lib/ag-grid.min.js:26:2785
    <anonymous> self-hosted:973:17

What am I doing wrong?

[bernhard]

Sorry, I can't provide free support here for such specific problems atm. You might try to search the repository for "filterchanged" and see how I use it in different occations,

[Beluga]

Thanks for the free support ? I got it working with the syntax

grid.gridOptions.api.addEventListener('filterChanged', function() { afterFilter() });

This allows me to pass the grid object to afterFilter and then do interesting stuff with grid.gridOptions.api.getModel().rootNode.childrenAfterFilter

I am going to mess around with dynamic charting!!

[bernhard]

2 hours ago, Beluga said:

I am going to mess around with dynamic charting!!

Glad you got it working, seems you start having fun using it? ? What chart library are you using?

[bernhard]

The new concept of function for manipulating the columns really makes sense and is great to work with ? Whenever you create useful coldef functions please let me know - maybe others can also benefit from it. Here is one new that I just added:

RockGrid.colDefs.yesNo()

Here a simple example showing the status of an E-Mail (sent yes or no):

  col = grid.getColDef('rockmailer_sent');
  col = RockGrid.colDefs.yesNo(col, {headerName: 'Status'});

And here a "more complex" example that splits a page reference field with a list of IDs and returns true if a page is part of that list and false if is not:

    col = RockGrid.colDefs.yesNo(col, {
      headerName: grid.js.listtitle,
      isYes: function(val) {
        if(!val) return false;
        val = val.split(",");
        return val.indexOf(String(grid.js.list)) > -1 ? true : false;
      }
    });

 

[Beluga]

On 11/4/2018 at 3:53 PM, bernhard said:

Glad you got it working, seems you start having fun using it? ? What chart library are you using?

I am using ApexCharts.js, which is kind of a spiritual successor to Chartist.js in that they both produce SVG charts. I am experimenting with what is possible, trying to figure out visualisations of the data that would be useful and attractive.

Here is a screenshot of ApexCharts playing together in real time with RockGrid filtering (edit: nevermind the incorrect/repeating data labels, I only noticed and corrected later):

We see a stacked bar chart representation of the number of literature references per filtered proverb type. I intend to split the thing into separate charts for each of the 13 top level categories (ApexCharts unfortunately does not support multiple series of stacked bars in a single chart). This will make it readable even with the unfiltered view of all 325 proverb types.

It was quite convoluted to get the libraries to play together - grid.gridOptions.api.getModel().rootNode.childrenAfterFilter did not want to yield its contents, but guarded it like a jealous dragon. To get access to the data, I had to brute-force dispatch an input event like so:

  var inputTarget = document.querySelector('.ag-floating-filter-full-body:first-child input');
  var inputEvent = new Event('input', {'bubbles': true, 'cancelable': true});
  // have to use delta timing to delay the input event - in
  // case of big existing CPU load, it will fire too soon!
  var start = new Date().getTime();
    setTimeout(function() {
    var now = new Date().getTime(), delta = now-start;
    inputTarget.dispatchEvent(inputEvent);
    },500);

Then, to initialise the Apex chart in proper order, I had to wrap its stuff into a function. I called the function from my afterFilter:

function afterFilter(grid) {
    var filterKids = grid.gridOptions.api.getModel().rootNode.childrenAfterFilter;
    var mapCodes = filterKids.map(x => x.data.code);
    var countedCodes = mapCodes.reduce((r,k)=>{r[k]=1+r[k]||1;return r},{});
    apexseries = Object.entries(countedCodes).map(([p, v]) => ({'name':p, 'data':[v]}));
    var apexdiv = document.querySelector("#chart");
    if(!apexdiv.hasChildNodes()) { apexi(); } else { ApexCharts.exec('proverbs', 'updateSeries', apexseries); }
}

 

[bernhard]

Awesome to see that, need to look at that library as I've never heard about it...

30 minutes ago, Beluga said:

It was quite convoluted to get the libraries to play together - grid.gridOptions.api.getModel().rootNode.childrenAfterFilter did not want to yield its contents, but guarded it like a jealous dragon. To get access to the data, I had to brute-force dispatch an input event like so:

I've built a function to get data instantly very easily - have a look at the pluck() function in RockGridItem.js; It works similar to jQuery Datatables library that I've used before. And I found getting data there quite easier than with aggrid. That's why I built a similar replacement.

See this example where I can select selected or filtered items:

    // get items
    var rockmailer_to = $('input[name=rockmailer_to]:checked').val();
    var items;
    var testmail = false;
    if(rockmailer_to == 'selected') items = grid.pluck('id', {selected: true});
    else if(rockmailer_to == 'filtered') items = grid.pluck('id', {filter: true});
    else {
      // custom test address
      var testmail = $('#Inputfield_rockmailer_test').val();
      if(!testmail) {
        ProcessWire.alert('You need to specify a Test-Mail-Address!');
        return;
      }
      items = [testmail];
      testmail = true;
    }
    if(!items.length) ProcessWire.alert('No items selected/filtered');

 

Wow @Beluga just had a look at apex charts and that looks fantastic! I was short before creating a module for chartjs but then quite a lot of client work popped in... I'd be very happy to assist you in creating a charting module that plays well together with RockGrid, so if you are interested please drop me a line via PM ? 

[bernhard]

v18 adds a plugin that can sync page fields with rockgrid columns:

Example Setup

Adding the asm in a processmodule. $fs is a fieldset where we add our InputField to. $gridname is the name of the grid that is connected.

    // which lists to show
    $this->wire->config->scripts->append($this->wire->urls($this) . "scripts/manageLists.js");
    $fs->add([
      'type' => 'InputfieldAsmSelect',
      'name' => 'listsToShow',
      'label' => __('Show list membership for...'),
      'attr' => ['data-grid' => $gridname],
      'asmOptions' => ['sortable'=>false],
    ]);
    $f = $fs->getChildByName('listsToShow');
    $f->setAsmSelectOption('sortable', false);
    foreach($pages->get('template=rockmailer_lists')->children as $item) {
      $f->addOption($item->id, $item->title);
    }

And the portion of the javascript file:

// sync ASM field with displayed lists in grid
// attach event listener when document is ready
$(document).ready(function() {
  var $select = $('#Inputfield_listsToShow');
  var colPrefix = 'rockmailer_list_';
  
  RockGrid.plugins.syncAsmSelect({
    asm: $('#Inputfield_listsToShow'),
    grid: RockGrid.getGrid($select.data('grid')),
    colName: function(pageId) { return colPrefix + pageId; },
    colDef: function(col) {
      col = RockGrid.colDefs.yesNo(col, {
        isYes: function(params) {
          var pageId = String(params.column.colId).replace(colPrefix, '');
          var lists = String(params.data.rockmailer_lists).split(',');
          return lists.indexOf(pageId) > -1 ? true : false;
        }
      });
      col.pinned = 'left';
      return col;
    }
  });
});

In this case we set a custom callback to modify the colDef for the column. It uses the yesNo plugin to show icons instead of true/false values: