Add Initial filter

[AMBudnik]

Description

Filters should have the ability to load presets of filters conditions without an extra refresh of Handsontable. What's important, we should give the possibility to do it by Handsontable cell meta settings. We are following the example of this functionality provided by ParamQuery Pro (as shown in the picture below).

Moved from GL #176

[wszymanski]

Sample configuration which could be handled by the plugin:

columns: [
  { 
    data: 'id', 
    readOnly: true,
    filters: {
      conditions: [['eq', 7], ['between', 11, 15]],
      operation: 'disjunction'
    }
  }
]

[wszymanski]

I've tried to achieve assumption by handling changes in cells meta. Now it isn't possible, mainly by restrictions of updateSetttings. This function should be rewritten.

Problems:

• Plugin's isEnabled, enablePlugin don't have access to cells meta until Core init function is executed.
• Plugin's updatePlugin function is executed even if no properties affecting to the plugin are changed by updateSettings.

I've tried to produce workaround by:

• Doing mock of isEnabled:

isEnabled() {
  if (this.initialized) {
    return this.enabled;
  }

  return false;
}

• Adding onAfterInit listener in the constructor of the plugin.

this.addHook('afterInit', () => this.onAfterInit());

• React to actions which can change cell meta in the listener.

onAfterInit() {
  this.buildConditionsByCellsMeta();

  // TODO: Workaround. We add functions here, because `filters` property can be set / unset
  // by `setCellMeta` and `removeCellMeta` when plugin isn't enabled.

  this.addHook('afterSetCellMeta', (row, col, key, value) => this.onAfterSetCellMeta(row, col, key));
  this.addHook('afterRemoveCellMeta', (row, col, key, value) => this.onAfterRemoveCellMeta(row, col, key));

  // TODO: Workaround. We enable plugin & set conditions basing on cell meta.
  this.addHook('afterUpdateSettings', (settings) => this.onAfterUpdateSettings(settings));
}

It works, but CE tests are failing and we don't want to change it for just workarounds.

[AMBudnik]

Thanks for adding @wszymanski 👍

[wszymanski]

Some changes on the old, private repo: https://git.handsontable.com/handsontable-dev/handsontable-pro/commits/feature/issue-176

[AMBudnik]

I'm moving this topic to Github Discussions. I welcome everyone to discuss this functionality and share your feedback. See you there!

[andraz-podobnik]

My view on this - Filters Plugin should get a function that works in the same way as what's already available for sorting - MultiColumnSorting.setSortConfig().