DayPilot.Gantt.rows.filter

The rows.filter() method filters JavaScript Gantt Chart component tasks using the specified filter parameter.

Available since 2022.4.5452.

Declaration

DayPilot.Gantt.rows.filter(params)

Parameters

• params (object|string) - custom object or simple string value passed to onRowFilter as args.filterParam

Notes

Call this method to re-run row filtering logic after updating the filter value that your onRowFilter handler reads from args.filterParam.

Example

<div class="space">
Filter: <input id="filter" /> <a href="#" id="clear">Clear</a>
</div>

<div id="dp"></div>

<script>
const dp = new DayPilot.Gantt("dp", {
  onRowFilter: (args) => {
    const query = args.filterParam.query;

    if (!args.task.data.text.toUpperCase().includes(query.toUpperCase())) {
      args.visible = false;
    }
  },
  // ...
});
dp.init();

const app = {
  elements: {
    filter: document.querySelector("#filter"),
    clear: document.querySelector("#clear")
  },
  init() {
    const { filter, clear } = this.elements;

    filter.addEventListener("keyup", () => this.filter());

    clear.addEventListener("click", (ev) => {
      ev.preventDefault();
      filter.value = "";
      this.filter();
    });
  },
  filter() {
    // Filter is applied using the onRowFilter event handler.
    dp.rows.filter({
      query: this.elements.filter.value
    });
  }
};

app.init();
</script>

See Also

DayPilot.Gantt.onRowFilter

DayPilot.Gantt Class